From 3228865d964499295f90e89f13411f5db1d3f334 Mon Sep 17 00:00:00 2001 From: Gregor Martynus <39992+gr2m@users.noreply.github.com> Date: Tue, 10 Nov 2020 16:22:39 -0800 Subject: [PATCH] feat: `actions.{disableSelectedRepositoryGithubActionsOrganization,disableWorkflow,enableSelectedRepositoryGithubActionsOrganization,enableWorkflow,getAllowedActionsOrganization,getAllowedActionsRepository,getGithubActionsPermissionsOrganization,listSelectedRepositoriesEnabledGithubActionsOrganization,setAllowedActionsOrganization,setAllowedActionsRepository,setGithubActionsPermissionsOrganization,setGithubActionsPermissionsRepository,setSelectedRepositoriesEnabledGithubActionsOrganization}`, `apps.{getWebhookConfigForApp,updateWebhookConfigForApp}`, `enterpriseAdmin.*`, `orgs.{getWebhookConfigForOrg,updateWebhookConfigForOrg}`, `repos.{getWebhookConfigForRepo,updateWebhookConfigForRepo}` --- src/generated/endpoints.ts | 156 +- src/generated/method-types.ts | 1134 ++++++--- .../parameters-and-response-types.ts | 2266 +++++++++-------- 3 files changed, 2184 insertions(+), 1372 deletions(-) diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 232a98ccc..44f4dddab 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -41,6 +41,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = { 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}", ], @@ -50,11 +56,33 @@ const Endpoints: EndpointsDefaultsAndDecorations = { 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}"], + 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}"], - getRepoPermissions: ["GET /repos/{owner}/{repo}/actions/permissions"], + 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}"], getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], @@ -83,6 +111,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { 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: [ @@ -96,9 +127,24 @@ const Endpoints: EndpointsDefaultsAndDecorations = { removeSelectedRepoFromOrgSecret: [ "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", ], + 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}"], @@ -173,6 +219,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "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", @@ -198,6 +245,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { unsuspendInstallation: [ "DELETE /app/installations/{installation_id}/suspended", ], + updateWebhookConfigForApp: ["PATCH /app/hook/config"], }, billing: { getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], @@ -216,50 +264,25 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], }, checks: { - create: [ - "POST /repos/{owner}/{repo}/check-runs", - { mediaType: { previews: ["antiope"] } }, - ], - createSuite: [ - "POST /repos/{owner}/{repo}/check-suites", - { mediaType: { previews: ["antiope"] } }, - ], - get: [ - "GET /repos/{owner}/{repo}/check-runs/{check_run_id}", - { mediaType: { previews: ["antiope"] } }, - ], - getSuite: [ - "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}", - { mediaType: { previews: ["antiope"] } }, - ], + 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", - { mediaType: { previews: ["antiope"] } }, - ], - listForRef: [ - "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", - { mediaType: { previews: ["antiope"] } }, ], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], listForSuite: [ "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - { mediaType: { previews: ["antiope"] } }, - ], - listSuitesForRef: [ - "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", - { mediaType: { previews: ["antiope"] } }, ], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], rerequestSuite: [ "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - { mediaType: { previews: ["antiope"] } }, ], setSuitesPreferences: [ "PATCH /repos/{owner}/{repo}/check-suites/preferences", - { mediaType: { previews: ["antiope"] } }, - ], - update: [ - "PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}", - { mediaType: { previews: ["antiope"] } }, ], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], }, codeScanning: { getAlert: [ @@ -289,6 +312,32 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], }, 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"], @@ -331,30 +380,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getTemplate: ["GET /gitignore/templates/{name}"], }, interactions: { - getRestrictionsForOrg: [ - "GET /orgs/{org}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, - ], - getRestrictionsForRepo: [ - "GET /repos/{owner}/{repo}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, - ], - removeRestrictionsForOrg: [ - "DELETE /orgs/{org}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, - ], + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], removeRestrictionsForRepo: [ "DELETE /repos/{owner}/{repo}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, - ], - setRestrictionsForOrg: [ - "PUT /orgs/{org}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, - ], - setRestrictionsForRepo: [ - "PUT /repos/{owner}/{repo}/interaction-limits", - { mediaType: { previews: ["sombra"] } }, ], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], }, issues: { addAssignees: [ @@ -513,6 +546,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { 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"], @@ -544,6 +578,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PATCH /user/memberships/orgs/{org}", ], updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], }, projects: { addCollaborator: [ @@ -762,7 +797,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { { mediaType: { previews: ["squirrel-girl"] } }, { deprecated: - "octokit.reactions.deleteLegacy() is deprecated, see https://developer.github.com/v3/reactions/#delete-a-reaction-legacy", + "octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy", }, ], listForCommitComment: [ @@ -940,10 +975,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { mediaType: { previews: ["zzzax"] } }, ], - getCommunityProfileMetrics: [ - "GET /repos/{owner}/{repo}/community/profile", - { mediaType: { previews: ["black-panther"] } }, - ], + 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}"], @@ -977,6 +1009,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], 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", @@ -1100,6 +1135,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "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" }, diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index c79cf0d15..e057dabf9 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -4,7 +4,7 @@ import { RestEndpointMethodTypes } from "./parameters-and-response-types"; export 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://developer.github.com/v3/actions/secrets/#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. + * 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: { ( @@ -287,11 +287,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yml`. + * 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://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * 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: { ( @@ -393,6 +393,34 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["actions"]["disableSelectedRepositoryGithubActionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["disableWorkflow"]["response"] + >; + 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 @@ -438,6 +466,62 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["actions"]["enableSelectedRepositoryGithubActionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["enableWorkflow"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["getAllowedActionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["getAllowedActionsRepository"]["response"] + >; + 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. */ @@ -448,6 +532,35 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsRepository"]["response"] + >; + 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. */ @@ -484,6 +597,22 @@ export type RestEndpointMethods = { 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.actions.getRepoPermissions() has been renamed to octokit.actions.getGithubActionsPermissionsRepository() (2020-11-10) + */ + getRepoPermissions: { + ( + params?: RestEndpointMethodTypes["actions"]["getRepoPermissions"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getRepoPermissions"]["response"] + >; + 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. */ @@ -538,7 +667,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. 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. + * 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: { ( @@ -562,7 +691,7 @@ export type RestEndpointMethods = { /** * **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." * - * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * 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. */ @@ -578,9 +707,9 @@ export type RestEndpointMethods = { /** * **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." * - * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * 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 also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. 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 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: { ( @@ -604,7 +733,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#parameters). + * 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: { ( @@ -691,6 +820,20 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["actions"]["listSelectedRepositoriesEnabledGithubActionsOrganization"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Lists all self-hosted runners configured in an organization. * @@ -706,8 +849,7 @@ export type RestEndpointMethods = { 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. + * 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: { ( @@ -731,7 +873,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + * 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. */ @@ -745,7 +887,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#parameters). + * 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. */ @@ -771,7 +913,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/actions/secrets/#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. + * 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: { ( @@ -783,7 +925,75 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/actions/secrets/#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. + * 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< + RestEndpointMethodTypes["actions"]["setAllowedActionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["setAllowedActionsRepository"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsOrganization"]["response"] + >; + 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< + RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsRepository"]["response"] + >; + 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: { ( @@ -794,6 +1004,20 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["actions"]["setSelectedRepositoriesEnabledGithubActionsOrganization"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; activity: { checkRepoIsStarredByAuthenticatedUser: { @@ -806,7 +1030,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/watching/#set-a-repository-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). */ deleteRepoSubscription: { ( @@ -818,7 +1042,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/notifications/#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * 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: { ( @@ -833,14 +1057,14 @@ export type RestEndpointMethods = { * 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://developer.github.com/v3/#hypermedia) + * * **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://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **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: { ( @@ -868,7 +1092,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/watching/#get-a-repository-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. */ @@ -1006,7 +1230,7 @@ export type RestEndpointMethods = { /** * Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: + * 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: { ( @@ -1020,7 +1244,7 @@ export type RestEndpointMethods = { /** * Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: + * 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: { ( @@ -1046,7 +1270,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/media/) via the `Accept` header: + * 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: { ( @@ -1082,7 +1306,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/notifications/#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * 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: { ( @@ -1094,7 +1318,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/notifications/#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * 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: { ( @@ -1116,7 +1340,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely. + * 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: { ( @@ -1132,7 +1356,7 @@ export type RestEndpointMethods = { * * 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://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription) endpoint. + * 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: { ( @@ -1144,7 +1368,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#http-verbs)." + * 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: { ( @@ -1170,7 +1394,7 @@ export type RestEndpointMethods = { /** * 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/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint. + * You must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint. */ addRepoToInstallation: { ( @@ -1182,7 +1406,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/auth#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`. + * 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: { ( @@ -1192,11 +1416,11 @@ export type RestEndpointMethods = { 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` of the content reference from the [`content_reference` event](https://developer.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * 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://developer.github.com/apps/using-content-attachments/)" for details about content attachments. + * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this 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. */ createContentAttachment: { ( @@ -1208,7 +1432,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://developer.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`. + * 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: { ( @@ -1222,7 +1446,7 @@ export type RestEndpointMethods = { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1234,8 +1458,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * + * 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: { @@ -1248,9 +1471,9 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/apps/#suspend-an-app-installation)" endpoint. + * 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/v3/apps/#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1262,7 +1485,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. + * 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: { ( @@ -1272,9 +1495,9 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/apps/#list-installations-for-the-authenticated-app)" endpoint. + * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this 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: { ( @@ -1288,7 +1511,7 @@ export type RestEndpointMethods = { /** * **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://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * 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: { ( @@ -1300,7 +1523,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this 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. */ getInstallation: { ( @@ -1314,7 +1537,7 @@ export type RestEndpointMethods = { /** * Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1328,7 +1551,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this 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. */ getRepoInstallation: { ( @@ -1342,7 +1565,7 @@ export type RestEndpointMethods = { /** * 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://developer.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://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1356,7 +1579,7 @@ export type RestEndpointMethods = { /** * 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://developer.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://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1370,7 +1593,7 @@ export type RestEndpointMethods = { /** * Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1381,10 +1604,24 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["apps"]["getWebhookConfigForApp"]["response"] + >; + 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://developer.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://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1398,7 +1635,7 @@ export type RestEndpointMethods = { /** * 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://developer.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://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1414,7 +1651,7 @@ export type RestEndpointMethods = { * * 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://developer.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. + * 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. */ @@ -1428,7 +1665,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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. */ @@ -1444,7 +1681,7 @@ export type RestEndpointMethods = { /** * 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://developer.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. + * 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. * @@ -1462,7 +1699,7 @@ export type RestEndpointMethods = { /** * Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1474,7 +1711,7 @@ export type RestEndpointMethods = { /** * Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. + * 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: { ( @@ -1488,7 +1725,7 @@ export type RestEndpointMethods = { /** * List repositories that an app installation can access. * - * You must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * 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: { ( @@ -1500,7 +1737,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://developer.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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/). + * 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: { ( @@ -1512,7 +1749,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://developer.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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/). + * 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: { ( @@ -1526,7 +1763,7 @@ export type RestEndpointMethods = { /** * 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/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint. + * You must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint. */ removeRepoFromInstallation: { ( @@ -1538,7 +1775,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * 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: { ( @@ -1550,9 +1787,9 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/apps/#create-an-installation-access-token-for-an-app)" 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this 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: { ( @@ -1564,13 +1801,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://developer.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." * * 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. * * To suspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1582,13 +1819,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://developer.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." * * Removes a GitHub App installation suspension. * * To unsuspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed and suspended. * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * 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: { ( @@ -1599,14 +1836,26 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; billing: { /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * 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)". * * Access tokens must have the `read:org` scope. */ @@ -1620,11 +1869,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * 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)". * * Access tokens must have the `user` scope. */ @@ -1638,11 +1885,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-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 `read:org` scope. */ @@ -1656,11 +1901,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-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. */ @@ -1674,11 +1917,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-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 `read:org` scope. */ @@ -1692,11 +1933,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Warning:** The Billing API is currently in public beta and subject to change. - * * 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-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. */ @@ -1715,6 +1954,8 @@ export type RestEndpointMethods = { * **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: { ( @@ -1726,7 +1967,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/checks/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://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * 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: { ( @@ -1810,7 +2051,7 @@ export type RestEndpointMethods = { 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://developer.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. + * 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. */ @@ -1824,7 +2065,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * 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: { ( @@ -1850,8 +2091,9 @@ export type RestEndpointMethods = { }; codeScanning: { /** - * Gets a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. - * GitHub Apps must have the `security_events` read permission to use this endpoint. + * 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. + * + * The security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`. */ getAlert: { ( @@ -1958,6 +2200,120 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["enterpriseAdmin"]["disableSelectedOrganizationGithubActionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["enableSelectedOrganizationGithubActionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["getAllowedActionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["getGithubActionsPermissionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["listSelectedOrganizationsEnabledGithubActionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["setAllowedActionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["setGithubActionsPermissionsEnterprise"]["response"] + >; + 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< + RestEndpointMethodTypes["enterpriseAdmin"]["setSelectedOrganizationsEnabledGithubActionsEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; gists: { checkIsStarred: { ( @@ -2085,7 +2441,7 @@ export type RestEndpointMethods = { /** * List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://developer.github.com/v3/#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. + * 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: { ( @@ -2105,7 +2461,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#http-verbs)." + * 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: { ( @@ -2199,8 +2555,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary. - * + * 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** * @@ -2241,7 +2596,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/git/commits/#create-a-commit)" and "[Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference)." + * 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: { ( @@ -2273,7 +2628,6 @@ export type RestEndpointMethods = { /** * 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: @@ -2313,7 +2667,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/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://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". + * **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: { ( @@ -2376,7 +2730,7 @@ export type RestEndpointMethods = { * * 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://developer.github.com/v3/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://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". + * **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`. */ @@ -2400,7 +2754,7 @@ export type RestEndpointMethods = { }; gitignore: { /** - * List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user). + * 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: { ( @@ -2413,8 +2767,7 @@ export type RestEndpointMethods = { }; /** * The API also allows fetching the source of a single template. - * - * Use the raw [media type](https://developer.github.com/v3/media/) to get the raw contents. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ getTemplate: { ( @@ -2536,9 +2889,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -2548,7 +2901,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -2606,17 +2959,17 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was - * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * 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://developer.github.com/webhooks/event-payloads/#issues) webhook. + * 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ get: { ( @@ -2660,14 +3013,13 @@ export type RestEndpointMethods = { /** * 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. See the [Parameters table](https://developer.github.com/v3/issues/#parameters) for more - * information. + * 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ list: { ( @@ -2677,7 +3029,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ listAssignees: { ( @@ -2744,7 +3096,7 @@ export type RestEndpointMethods = { * **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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ listForAuthenticatedUser: { ( @@ -2761,7 +3113,7 @@ export type RestEndpointMethods = { * **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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ listForOrg: { ( @@ -2776,7 +3128,7 @@ export type RestEndpointMethods = { * **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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ listForRepo: { ( @@ -2828,7 +3180,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/#http-verbs)." + * 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: { ( @@ -2949,7 +3301,7 @@ export type RestEndpointMethods = { /** * This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://developer.github.com/v3/repos/contents/#get-repository-content), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML. + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos/contents#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: { ( @@ -2980,7 +3332,7 @@ export type RestEndpointMethods = { }; meta: { /** - * This endpoint provides a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." + * This endpoint provides 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/)." */ get: { (params?: RestEndpointMethodTypes["meta"]["get"]["parameters"]): Promise< @@ -2989,6 +3341,36 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["meta"]["root"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; migrations: { /** @@ -3004,7 +3386,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/migrations/users/#list-user-migrations) and [Get a user migration status](https://developer.github.com/v3/migrations/users/#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://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: { ( @@ -3074,7 +3456,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/migrations/source_imports/#map-a-commit-author) endpoint allow you to provide correct Git author information. + * 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: { ( @@ -3102,11 +3484,11 @@ export type RestEndpointMethods = { * * 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://developer.github.com/v3/migrations/source_imports/#update-an-import) section. + * * `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://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://developer.github.com/v3/migrations/source_imports/#update-an-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://developer.github.com/v3/migrations/source_imports/#update-an-import) section. + * * `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** * @@ -3150,7 +3532,7 @@ export type RestEndpointMethods = { * * `exported` - the migration finished successfully. * * `failed` - the migration failed. * - * Once the migration has been `exported` you can [download the migration archive](https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive). + * 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: { ( @@ -3241,7 +3623,7 @@ export type RestEndpointMethods = { 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://docs.github.com/articles/versioning-large-files/). + * 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: { ( @@ -3289,7 +3671,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Unlocks a repository. You can lock repositories when you [start a user migration](https://developer.github.com/v3/migrations/users/#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://developer.github.com/v3/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. + * 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: { ( @@ -3301,7 +3683,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data. + * 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: { ( @@ -3367,7 +3749,7 @@ export type RestEndpointMethods = { 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://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + * 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: { ( @@ -3381,7 +3763,7 @@ export type RestEndpointMethods = { /** * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -3411,9 +3793,9 @@ export type RestEndpointMethods = { 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://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see "[Response with GitHub plan information](https://developer.github.com/v3/orgs/#response-with-github-plan-information)." + * 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< @@ -3444,7 +3826,9 @@ export type RestEndpointMethods = { 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"] @@ -3452,10 +3836,24 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["orgs"]["getWebhookConfigForOrg"]["response"] + >; + 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://developer.github.com/v3/#link-header) to get the URL for the next page of organizations. + * **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< @@ -3505,9 +3903,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * 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://developer.github.com/v3/orgs/#list-organizations-for-the-authenticated-user) API instead. + * 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: { ( @@ -3593,7 +3991,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ pingWebhook: { ( @@ -3651,7 +4049,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/orgs/members/#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * 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. * @@ -3671,7 +4069,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/#http-verbs)." + * 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: { ( @@ -3712,7 +4110,9 @@ export type RestEndpointMethods = { 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"] @@ -3720,6 +4120,20 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["orgs"]["updateWebhookConfigForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; projects: { /** @@ -3737,7 +4151,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + * 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. */ createCard: { ( @@ -3984,13 +4398,13 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -4002,7 +4416,7 @@ export type RestEndpointMethods = { /** * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -4014,11 +4428,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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://developer.github.com/v3/media/#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://developer.github.com/v3/pulls/#get-a-pull-request) endpoint. + * **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/reference/media/#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. */ @@ -4032,13 +4446,13 @@ export type RestEndpointMethods = { /** * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. * - * 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://developer.github.com/v3/issues/comments/#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. + * 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 [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3). + * 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 [Multi-line comment summary](https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3). * * **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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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. * * **Multi-line comment summary** * @@ -4054,7 +4468,7 @@ export type RestEndpointMethods = { * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: * * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. + * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table. */ createReviewComment: { ( @@ -4088,7 +4502,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * **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: { ( @@ -4098,21 +4512,21 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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://developer.github.com/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/v3/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://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". + * 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://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.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://docs.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. + * * 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://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * 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< @@ -4148,9 +4562,9 @@ export type RestEndpointMethods = { * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: * * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. + * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table. * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. + * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions. */ getReviewComment: { ( @@ -4162,7 +4576,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -4184,7 +4598,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/repos/commits/#list-commits) endpoint. + * 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: { ( @@ -4232,9 +4646,9 @@ export type RestEndpointMethods = { * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: * * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. + * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table. * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. + * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions. */ listReviewComments: { ( @@ -4264,9 +4678,9 @@ export type RestEndpointMethods = { * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: * * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. + * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table. * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. + * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions. */ listReviewCommentsForRepo: { ( @@ -4288,7 +4702,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)" for details. */ merge: { ( @@ -4308,7 +4722,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)" for details. */ requestReviewers: { ( @@ -4328,7 +4742,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -4378,7 +4792,7 @@ export type RestEndpointMethods = { * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: * * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. + * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table. */ updateReviewComment: { ( @@ -4406,7 +4820,7 @@ export type RestEndpointMethods = { }; reactions: { /** - * Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment. + * Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment. */ createForCommitComment: { ( @@ -4418,7 +4832,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. + * Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. */ createForIssue: { ( @@ -4430,7 +4844,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment. + * Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment. */ createForIssueComment: { ( @@ -4442,7 +4856,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment. + * Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment. */ createForPullRequestReviewComment: { ( @@ -4454,7 +4868,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * 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 a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ @@ -4468,7 +4882,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * 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 a `Status: 200 OK` means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ @@ -4484,7 +4898,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/repos/comments/). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ deleteForCommitComment: { ( @@ -4498,7 +4912,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ deleteForIssue: { ( @@ -4512,7 +4926,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/issues/comments/). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ deleteForIssueComment: { ( @@ -4526,7 +4940,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/pulls/comments/). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ deleteForPullRequestComment: { ( @@ -4540,7 +4954,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -4554,7 +4968,7 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -4568,8 +4982,8 @@ export type RestEndpointMethods = { /** * **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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). - * @deprecated octokit.reactions.deleteLegacy() is deprecated, see https://developer.github.com/v3/reactions/#delete-a-reaction-legacy + * 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.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy */ deleteLegacy: { ( @@ -4581,7 +4995,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/). + * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ listForCommitComment: { ( @@ -4593,7 +5007,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to an [issue](https://developer.github.com/v3/issues/). + * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ listForIssue: { ( @@ -4605,7 +5019,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/). + * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ listForIssueComment: { ( @@ -4617,7 +5031,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). + * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ listForPullRequestReviewComment: { ( @@ -4629,7 +5043,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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`. */ @@ -4643,7 +5057,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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`. */ @@ -4668,7 +5082,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -4686,13 +5100,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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://docs.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)". + * 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://developer.github.com/v3/#http-verbs)." + * 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://developer.github.com/v3/repos/invitations/). + * 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** * @@ -4708,7 +5122,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -4720,7 +5134,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -4738,7 +5152,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -4770,7 +5184,7 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * 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: { ( @@ -4784,13 +5198,13 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * 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** * - * The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://developer.github.com/v3/repos/commits/#list-commits) to enumerate all commits in the range. + * The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) to enumerate all commits in the range. * * For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long * to generate. You can typically resolve this error by using a smaller commit range. @@ -4836,7 +5250,7 @@ export type RestEndpointMethods = { /** * Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -4848,7 +5262,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -4902,7 +5316,7 @@ export type RestEndpointMethods = { * 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://developer.github.com/v3/repos/statuses) for every submitted context must be in a `success` + * 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. @@ -4958,11 +5372,11 @@ export type RestEndpointMethods = { 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://developer.github.com/webhooks/event-payloads/#repository_dispatch)." + * 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. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4). + * 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. * - * To give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * To give you write access to the repository, you must use a personal access token with the `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. * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ @@ -4980,7 +5394,7 @@ export type RestEndpointMethods = { * * **OAuth scope requirements** * - * When using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * 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 * * `repo` scope to create a private repository @@ -5011,7 +5425,7 @@ export type RestEndpointMethods = { * * **OAuth scope requirements** * - * When using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * 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 * * `repo` scope to create a private repository @@ -5050,7 +5464,7 @@ export type RestEndpointMethods = { /** * Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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: { ( @@ -5060,11 +5474,11 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/repos/#get-a-repository) endpoint and check that the `is_template` key is `true`. + * 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * 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 * * `repo` scope to create a private repository @@ -5113,7 +5527,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5127,7 +5541,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5141,7 +5555,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5163,7 +5577,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5196,7 +5610,7 @@ export type RestEndpointMethods = { * * 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://developer.github.com/v3/repos/deployments/#create-a-deployment)" and "[Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ deleteDeployment: { ( @@ -5244,7 +5658,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5284,7 +5698,7 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/configuring-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)". */ disableAutomatedSecurityFixes: { ( @@ -5296,7 +5710,7 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * 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: { ( @@ -5308,12 +5722,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or - * `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually + * 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.repos.downloadArchive() has been renamed to octokit.repos.downloadZipballArchive() (2020-09-17) */ downloadArchive: { ( @@ -5325,7 +5738,37 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/configuring-automated-security-fixes)". + * 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< + RestEndpointMethodTypes["repos"]["downloadTarballArchive"]["response"] + >; + 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< + RestEndpointMethodTypes["repos"]["downloadZipballArchive"]["response"] + >; + 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: { ( @@ -5337,7 +5780,7 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * 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: { ( @@ -5361,7 +5804,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -5377,7 +5820,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5389,7 +5832,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5409,7 +5852,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5431,7 +5874,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5479,7 +5922,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/#pagination) if there are over 100 contexts. + * 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: * @@ -5501,9 +5944,9 @@ export type RestEndpointMethods = { * * **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://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * 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://developer.github.com/v3/media/#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. + * 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** * @@ -5564,9 +6007,9 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * 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. */ @@ -5595,15 +6038,15 @@ export type RestEndpointMethods = { * 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 all files in the repository. * - * Files and symlinks support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) for + * 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://developer.github.com/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent + * 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://developer.github.com/v3/git/trees/). + * * 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://developer.github.com/v3/git/trees/#get-a-tree). + * 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 @@ -5732,7 +6175,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5764,7 +6207,7 @@ export type RestEndpointMethods = { /** * Gets the preferred README for a repository. * - * READMEs support [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ getReadme: { ( @@ -5774,7 +6217,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#hypermedia). + * **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: { ( @@ -5784,7 +6227,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#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. + * 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: { ( @@ -5808,7 +6251,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -5820,7 +6263,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5856,7 +6299,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5879,7 +6322,9 @@ export type RestEndpointMethods = { 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"] @@ -5887,6 +6332,20 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["repos"]["getWebhookConfigForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; listBranches: { ( @@ -5896,7 +6355,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -5936,7 +6395,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/). + * 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. */ @@ -6137,7 +6596,7 @@ export type RestEndpointMethods = { /** * Lists all public repositories in the order that they were created. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories. + * 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 repositories. */ listPublic: { ( @@ -6147,7 +6606,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will 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://developer.github.com/v3/pulls/#list-pull-requests) endpoint. + * Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will 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: { ( @@ -6169,7 +6628,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/repos/#list-repository-tags). + * 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. */ @@ -6213,7 +6672,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ pingWebhook: { ( @@ -6223,7 +6682,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6251,7 +6710,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -6263,7 +6722,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -6275,7 +6734,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6293,7 +6752,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6335,7 +6794,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. */ @@ -6349,7 +6808,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6367,7 +6826,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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: { ( @@ -6379,7 +6838,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6397,7 +6856,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6429,7 +6888,7 @@ export type RestEndpointMethods = { 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://docs.github.com/articles/about-repository-transfers/). + * 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: { ( @@ -6439,7 +6898,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://developer.github.com/v3/repos/#replace-all-repository-topics) endpoint. + * **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: { ( @@ -6449,7 +6908,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6499,7 +6958,7 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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. * @@ -6537,9 +6996,10 @@ export type RestEndpointMethods = { 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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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.repos.updateStatusCheckPotection() has been renamed to octokit.repos.updateStatusCheckProtection() (2020-09-17) */ updateStatusCheckPotection: { ( @@ -6550,7 +7010,23 @@ export type RestEndpointMethods = { 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< + RestEndpointMethodTypes["repos"]["updateStatusCheckProtection"]["response"] + >; + 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"] @@ -6559,8 +7035,22 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#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://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset. + * 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< + RestEndpointMethodTypes["repos"]["updateWebhookConfigForRepo"]["response"] + >; + 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. * @@ -6574,7 +7064,7 @@ export type RestEndpointMethods = { * 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://developer.github.com/v3/repos/releases/#list-assets-for-a-release)" + * * 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://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. */ @@ -6590,9 +7080,9 @@ export type RestEndpointMethods = { }; search: { /** - * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6617,10 +7107,10 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6634,16 +7124,18 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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, whick 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: { ( @@ -6655,9 +7147,9 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6673,9 +7165,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6695,9 +7187,9 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * 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://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6713,9 +7205,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). + * 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://developer.github.com/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). + * 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: * @@ -6733,11 +7225,11 @@ export type RestEndpointMethods = { }; teams: { /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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. * @@ -6769,11 +7261,11 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#http-verbs)." + * 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://docs.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)". + * 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: { ( @@ -6801,7 +7293,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/media/) via the `application/vnd.github.v3.repository+json` accept header. + * 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. * @@ -6817,9 +7309,9 @@ export type RestEndpointMethods = { 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://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * 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://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * 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: { ( @@ -6829,9 +7321,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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`. */ @@ -6845,9 +7337,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://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`. */ @@ -6861,7 +7353,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -6875,7 +7367,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -6915,7 +7407,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -6929,7 +7421,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -6949,7 +7441,7 @@ export type RestEndpointMethods = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://developer.github.com/v3/teams/#create-a-team). + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ getMembershipForUserInOrg: { ( @@ -6985,7 +7477,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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`. */ @@ -6999,7 +7491,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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`. */ @@ -7013,7 +7505,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/). + * 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: { ( @@ -7081,11 +7573,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * 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://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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}`. */ @@ -7127,7 +7619,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -7141,7 +7633,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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}`. */ @@ -7221,7 +7713,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7233,7 +7725,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7257,7 +7749,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7269,7 +7761,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7281,7 +7773,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/#http-verbs)." + * 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. */ @@ -7309,11 +7801,11 @@ export type RestEndpointMethods = { /** * 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://developer.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](https://developer.github.com/v3/users/#response-with-github-plan-information)." + * 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://developer.github.com/v3/#authentication). + * 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://developer.github.com/v3/users/emails/)". + * 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: { ( @@ -7342,7 +7834,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7354,7 +7846,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7368,7 +7860,7 @@ export type RestEndpointMethods = { /** * 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://developer.github.com/v3/#link-header) to get the URL for the next page of users. + * 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: { ( @@ -7450,7 +7942,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( @@ -7474,7 +7966,7 @@ export type RestEndpointMethods = { 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://developer.github.com/v3/users/emails/#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * 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: { ( @@ -7498,7 +7990,7 @@ export type RestEndpointMethods = { 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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * 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: { ( diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index f36833bf9..386320f1b 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -5,404 +5,524 @@ export type RestEndpointMethodTypes = { addSelectedRepoToOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"]["parameters"], + Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"]["response"]; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; }; cancelWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/actions/runs/:run_id/cancel"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/actions/runs/:run_id/cancel"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"]["response"]; }; createOrUpdateOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/actions/secrets/:secret_name"]["parameters"], + Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/actions/secrets/:secret_name"]["response"]; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}"]["response"]; }; createOrUpdateRepoSecret: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/actions/secrets/:secret_name"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; }; createRegistrationTokenForOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/actions/runners/registration-token"]["parameters"], + Endpoints["POST /orgs/{org}/actions/runners/registration-token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/actions/runners/registration-token"]["response"]; + response: Endpoints["POST /orgs/{org}/actions/runners/registration-token"]["response"]; }; createRegistrationTokenForRepo: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/actions/runners/registration-token"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/actions/runners/registration-token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/actions/runners/registration-token"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/registration-token"]["response"]; }; createRemoveTokenForOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/actions/runners/remove-token"]["parameters"], + Endpoints["POST /orgs/{org}/actions/runners/remove-token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/actions/runners/remove-token"]["response"]; + response: Endpoints["POST /orgs/{org}/actions/runners/remove-token"]["response"]; }; createRemoveTokenForRepo: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/actions/runners/remove-token"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/actions/runners/remove-token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/actions/runners/remove-token"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/remove-token"]["response"]; }; createWorkflowDispatch: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/actions/workflows/:workflow_id/dispatches"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/actions/workflows/:workflow_id/dispatches"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"]["response"]; }; deleteArtifact: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; }; deleteOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/actions/secrets/:secret_name"]["parameters"], + Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/actions/secrets/:secret_name"]["response"]; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}"]["response"]; }; deleteRepoSecret: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; }; deleteSelfHostedRunnerFromOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/actions/runners/:runner_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/actions/runners/:runner_id"]["response"]; + response: Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}"]["response"]; }; deleteSelfHostedRunnerFromRepo: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/actions/runners/:runner_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/actions/runners/:runner_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; }; deleteWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/actions/runs/:run_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/actions/runs/:run_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; }; deleteWorkflowRunLogs: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/actions/runs/:run_id/logs"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/actions/runs/:run_id/logs"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + disableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + disableWorkflow: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"]["response"]; }; downloadArtifact: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"]["response"]; }; downloadJobLogsForWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/jobs/:job_id/logs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/jobs/:job_id/logs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"]; }; downloadWorkflowRunLogs: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/logs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + enableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + enableWorkflow: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["response"]; + }; + getAllowedActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/permissions/selected-actions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/logs"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + getAllowedActionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; }; getArtifact: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/artifacts/:artifact_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; + }; + getGithubActionsPermissionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/permissions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/artifacts/:artifact_id"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/permissions"]["response"]; + }; + getGithubActionsPermissionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; }; getJobForWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/jobs/:job_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/jobs/:job_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"]["response"]; }; getOrgPublicKey: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/secrets/public-key"]["parameters"], + Endpoints["GET /orgs/{org}/actions/secrets/public-key"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/secrets/public-key"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/secrets/public-key"]["response"]; }; getOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/secrets/:secret_name"]["parameters"], + Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + getRepoPermissions: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/secrets/:secret_name"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; }; getRepoPublicKey: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/secrets/public-key"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/secrets/public-key"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["response"]; }; getRepoSecret: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/secrets/:secret_name"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; }; getSelfHostedRunnerForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/runners/:runner_id"]["parameters"], + Endpoints["GET /orgs/{org}/actions/runners/{runner_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/runners/:runner_id"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/runners/{runner_id}"]["response"]; }; getSelfHostedRunnerForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runners/:runner_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runners/:runner_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; }; getWorkflow: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"]["response"]; }; getWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; }; getWorkflowRunUsage: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/timing"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/timing"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["response"]; }; getWorkflowUsage: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id/timing"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id/timing"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"]["response"]; }; listArtifactsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/artifacts"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/artifacts"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"]; }; listJobsForWorkflowRun: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/jobs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/jobs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]; }; listOrgSecrets: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/secrets"]["parameters"], + Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/secrets"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]; }; listRepoSecrets: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/secrets"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/secrets"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"]; }; listRepoWorkflows: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/workflows"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/workflows"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]; }; listRunnerApplicationsForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/runners/downloads"]["parameters"], + Endpoints["GET /orgs/{org}/actions/runners/downloads"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/runners/downloads"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["response"]; }; listRunnerApplicationsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runners/downloads"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runners/downloads"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["response"]; }; listSelectedReposForOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/secrets/:secret_name/repositories"]["parameters"], + Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + listSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/secrets/:secret_name/repositories"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]; }; listSelfHostedRunnersForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/actions/runners"]["parameters"], + Endpoints["GET /orgs/{org}/actions/runners"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/actions/runners"]["response"]; + response: Endpoints["GET /orgs/{org}/actions/runners"]["response"]; }; listSelfHostedRunnersForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runners"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runners"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"]; }; listWorkflowRunArtifacts: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/artifacts"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs/:run_id/artifacts"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]; }; listWorkflowRuns: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"]; }; listWorkflowRunsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/actions/runs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/actions/runs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]; }; reRunWorkflow: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/actions/runs/:run_id/rerun"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/actions/runs/:run_id/rerun"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["response"]; }; removeSelectedRepoFromOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + setAllowedActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/permissions/selected-actions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + setAllowedActionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/permissions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/permissions"]["response"]; + }; + setGithubActionsPermissionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/permissions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions"]["response"]; }; setSelectedReposForOrgSecret: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/actions/secrets/:secret_name/repositories"]["parameters"], + Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/actions/secrets/:secret_name/repositories"]["response"]; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + setSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/permissions/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories"]["response"]; }; }; activity: { checkRepoIsStarredByAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/starred/:owner/:repo"]["parameters"], + Endpoints["GET /user/starred/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/starred/:owner/:repo"]["response"]; + response: Endpoints["GET /user/starred/{owner}/{repo}"]["response"]; }; deleteRepoSubscription: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/subscription"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/subscription"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/subscription"]["response"]; }; deleteThreadSubscription: { parameters: RequestParameters & Omit< - Endpoints["DELETE /notifications/threads/:thread_id/subscription"]["parameters"], + Endpoints["DELETE /notifications/threads/{thread_id}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /notifications/threads/:thread_id/subscription"]["response"]; + response: Endpoints["DELETE /notifications/threads/{thread_id}/subscription"]["response"]; }; getFeeds: { parameters: RequestParameters & @@ -415,34 +535,34 @@ export type RestEndpointMethodTypes = { getRepoSubscription: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/subscription"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/subscription"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/subscription"]["response"]; }; getThread: { parameters: RequestParameters & Omit< - Endpoints["GET /notifications/threads/:thread_id"]["parameters"], + Endpoints["GET /notifications/threads/{thread_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /notifications/threads/:thread_id"]["response"]; + response: Endpoints["GET /notifications/threads/{thread_id}"]["response"]; }; getThreadSubscriptionForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /notifications/threads/:thread_id/subscription"]["parameters"], + Endpoints["GET /notifications/threads/{thread_id}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /notifications/threads/:thread_id/subscription"]["response"]; + response: Endpoints["GET /notifications/threads/{thread_id}/subscription"]["response"]; }; listEventsForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/events"]["parameters"], + Endpoints["GET /users/{username}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/events"]["response"]; + response: Endpoints["GET /users/{username}/events"]["response"]; }; listNotificationsForAuthenticatedUser: { parameters: RequestParameters & @@ -455,10 +575,10 @@ export type RestEndpointMethodTypes = { listOrgEventsForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/events/orgs/:org"]["parameters"], + Endpoints["GET /users/{username}/events/orgs/{org}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/events/orgs/:org"]["response"]; + response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"]; }; listPublicEvents: { parameters: RequestParameters & @@ -471,58 +591,58 @@ export type RestEndpointMethodTypes = { listPublicEventsForRepoNetwork: { parameters: RequestParameters & Omit< - Endpoints["GET /networks/:owner/:repo/events"]["parameters"], + Endpoints["GET /networks/{owner}/{repo}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /networks/:owner/:repo/events"]["response"]; + response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"]; }; listPublicEventsForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/events/public"]["parameters"], + Endpoints["GET /users/{username}/events/public"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/events/public"]["response"]; + response: Endpoints["GET /users/{username}/events/public"]["response"]; }; listPublicOrgEvents: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/events"]["parameters"], + Endpoints["GET /orgs/{org}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/events"]["response"]; + response: Endpoints["GET /orgs/{org}/events"]["response"]; }; listReceivedEventsForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/received_events"]["parameters"], + Endpoints["GET /users/{username}/received_events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/received_events"]["response"]; + response: Endpoints["GET /users/{username}/received_events"]["response"]; }; listReceivedPublicEventsForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/received_events/public"]["parameters"], + Endpoints["GET /users/{username}/received_events/public"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/received_events/public"]["response"]; + response: Endpoints["GET /users/{username}/received_events/public"]["response"]; }; listRepoEvents: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/events"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/events"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"]; }; listRepoNotificationsForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/notifications"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/notifications"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/notifications"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"]; }; listReposStarredByAuthenticatedUser: { parameters: RequestParameters & @@ -535,26 +655,26 @@ export type RestEndpointMethodTypes = { listReposStarredByUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/starred"]["parameters"], + Endpoints["GET /users/{username}/starred"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/starred"]["response"]; + response: Endpoints["GET /users/{username}/starred"]["response"]; }; listReposWatchedByUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/subscriptions"]["parameters"], + Endpoints["GET /users/{username}/subscriptions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/subscriptions"]["response"]; + response: Endpoints["GET /users/{username}/subscriptions"]["response"]; }; listStargazersForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stargazers"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stargazers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stargazers"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"]; }; listWatchedReposForAuthenticatedUser: { parameters: RequestParameters & @@ -567,10 +687,10 @@ export type RestEndpointMethodTypes = { listWatchersForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/subscribers"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/subscribers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/subscribers"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; }; markNotificationsAsRead: { parameters: RequestParameters & @@ -583,116 +703,116 @@ export type RestEndpointMethodTypes = { markRepoNotificationsAsRead: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/notifications"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/notifications"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/notifications"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/notifications"]["response"]; }; markThreadAsRead: { parameters: RequestParameters & Omit< - Endpoints["PATCH /notifications/threads/:thread_id"]["parameters"], + Endpoints["PATCH /notifications/threads/{thread_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /notifications/threads/:thread_id"]["response"]; + response: Endpoints["PATCH /notifications/threads/{thread_id}"]["response"]; }; setRepoSubscription: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/subscription"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/subscription"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/subscription"]["response"]; }; setThreadSubscription: { parameters: RequestParameters & Omit< - Endpoints["PUT /notifications/threads/:thread_id/subscription"]["parameters"], + Endpoints["PUT /notifications/threads/{thread_id}/subscription"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /notifications/threads/:thread_id/subscription"]["response"]; + response: Endpoints["PUT /notifications/threads/{thread_id}/subscription"]["response"]; }; starRepoForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["PUT /user/starred/:owner/:repo"]["parameters"], + Endpoints["PUT /user/starred/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /user/starred/:owner/:repo"]["response"]; + response: Endpoints["PUT /user/starred/{owner}/{repo}"]["response"]; }; unstarRepoForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/starred/:owner/:repo"]["parameters"], + Endpoints["DELETE /user/starred/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/starred/:owner/:repo"]["response"]; + response: Endpoints["DELETE /user/starred/{owner}/{repo}"]["response"]; }; }; apps: { addRepoToInstallation: { parameters: RequestParameters & Omit< - Endpoints["PUT /user/installations/:installation_id/repositories/:repository_id"]["parameters"], + Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /user/installations/:installation_id/repositories/:repository_id"]["response"]; + response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; }; checkToken: { parameters: RequestParameters & Omit< - Endpoints["POST /applications/:client_id/token"]["parameters"], + Endpoints["POST /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /applications/:client_id/token"]["response"]; + response: Endpoints["POST /applications/{client_id}/token"]["response"]; }; createContentAttachment: { parameters: RequestParameters & Omit< - Endpoints["POST /content_references/:content_reference_id/attachments"]["parameters"], + Endpoints["POST /content_references/{content_reference_id}/attachments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /content_references/:content_reference_id/attachments"]["response"]; + response: Endpoints["POST /content_references/{content_reference_id}/attachments"]["response"]; }; createFromManifest: { parameters: RequestParameters & Omit< - Endpoints["POST /app-manifests/:code/conversions"]["parameters"], + Endpoints["POST /app-manifests/{code}/conversions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /app-manifests/:code/conversions"]["response"]; + response: Endpoints["POST /app-manifests/{code}/conversions"]["response"]; }; createInstallationAccessToken: { parameters: RequestParameters & Omit< - Endpoints["POST /app/installations/:installation_id/access_tokens"]["parameters"], + Endpoints["POST /app/installations/{installation_id}/access_tokens"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /app/installations/:installation_id/access_tokens"]["response"]; + response: Endpoints["POST /app/installations/{installation_id}/access_tokens"]["response"]; }; deleteAuthorization: { parameters: RequestParameters & Omit< - Endpoints["DELETE /applications/:client_id/grant"]["parameters"], + Endpoints["DELETE /applications/{client_id}/grant"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /applications/:client_id/grant"]["response"]; + response: Endpoints["DELETE /applications/{client_id}/grant"]["response"]; }; deleteInstallation: { parameters: RequestParameters & Omit< - Endpoints["DELETE /app/installations/:installation_id"]["parameters"], + Endpoints["DELETE /app/installations/{installation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /app/installations/:installation_id"]["response"]; + response: Endpoints["DELETE /app/installations/{installation_id}"]["response"]; }; deleteToken: { parameters: RequestParameters & Omit< - Endpoints["DELETE /applications/:client_id/token"]["parameters"], + Endpoints["DELETE /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /applications/:client_id/token"]["response"]; + response: Endpoints["DELETE /applications/{client_id}/token"]["response"]; }; getAuthenticated: { parameters: RequestParameters & @@ -705,82 +825,90 @@ export type RestEndpointMethodTypes = { getBySlug: { parameters: RequestParameters & Omit< - Endpoints["GET /apps/:app_slug"]["parameters"], + Endpoints["GET /apps/{app_slug}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /apps/:app_slug"]["response"]; + response: Endpoints["GET /apps/{app_slug}"]["response"]; }; getInstallation: { parameters: RequestParameters & Omit< - Endpoints["GET /app/installations/:installation_id"]["parameters"], + Endpoints["GET /app/installations/{installation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /app/installations/:installation_id"]["response"]; + response: Endpoints["GET /app/installations/{installation_id}"]["response"]; }; getOrgInstallation: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/installation"]["parameters"], + Endpoints["GET /orgs/{org}/installation"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/installation"]["response"]; + response: Endpoints["GET /orgs/{org}/installation"]["response"]; }; getRepoInstallation: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/installation"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/installation"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/installation"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/installation"]["response"]; }; getSubscriptionPlanForAccount: { parameters: RequestParameters & Omit< - Endpoints["GET /marketplace_listing/accounts/:account_id"]["parameters"], + Endpoints["GET /marketplace_listing/accounts/{account_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /marketplace_listing/accounts/:account_id"]["response"]; + response: Endpoints["GET /marketplace_listing/accounts/{account_id}"]["response"]; }; getSubscriptionPlanForAccountStubbed: { parameters: RequestParameters & Omit< - Endpoints["GET /marketplace_listing/stubbed/accounts/:account_id"]["parameters"], + Endpoints["GET /marketplace_listing/stubbed/accounts/{account_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /marketplace_listing/stubbed/accounts/:account_id"]["response"]; + response: Endpoints["GET /marketplace_listing/stubbed/accounts/{account_id}"]["response"]; }; getUserInstallation: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/installation"]["parameters"], + Endpoints["GET /users/{username}/installation"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /users/{username}/installation"]["response"]; + }; + getWebhookConfigForApp: { + parameters: RequestParameters & + Omit< + Endpoints["GET /app/hook/config"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/installation"]["response"]; + response: Endpoints["GET /app/hook/config"]["response"]; }; listAccountsForPlan: { parameters: RequestParameters & Omit< - Endpoints["GET /marketplace_listing/plans/:plan_id/accounts"]["parameters"], + Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /marketplace_listing/plans/:plan_id/accounts"]["response"]; + response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; }; listAccountsForPlanStubbed: { parameters: RequestParameters & Omit< - Endpoints["GET /marketplace_listing/stubbed/plans/:plan_id/accounts"]["parameters"], + Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /marketplace_listing/stubbed/plans/:plan_id/accounts"]["response"]; + response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"]; }; listInstallationReposForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/installations/:installation_id/repositories"]["parameters"], + Endpoints["GET /user/installations/{installation_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/installations/:installation_id/repositories"]["response"]; + response: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"]; }; listInstallations: { parameters: RequestParameters & @@ -841,18 +969,18 @@ export type RestEndpointMethodTypes = { removeRepoFromInstallation: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/installations/:installation_id/repositories/:repository_id"]["parameters"], + Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/installations/:installation_id/repositories/:repository_id"]["response"]; + response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; }; resetToken: { parameters: RequestParameters & Omit< - Endpoints["PATCH /applications/:client_id/token"]["parameters"], + Endpoints["PATCH /applications/{client_id}/token"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /applications/:client_id/token"]["response"]; + response: Endpoints["PATCH /applications/{client_id}/token"]["response"]; }; revokeInstallationAccessToken: { parameters: RequestParameters & @@ -865,200 +993,208 @@ export type RestEndpointMethodTypes = { suspendInstallation: { parameters: RequestParameters & Omit< - Endpoints["PUT /app/installations/:installation_id/suspended"]["parameters"], + Endpoints["PUT /app/installations/{installation_id}/suspended"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /app/installations/:installation_id/suspended"]["response"]; + response: Endpoints["PUT /app/installations/{installation_id}/suspended"]["response"]; }; unsuspendInstallation: { parameters: RequestParameters & Omit< - Endpoints["DELETE /app/installations/:installation_id/suspended"]["parameters"], + Endpoints["DELETE /app/installations/{installation_id}/suspended"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /app/installations/:installation_id/suspended"]["response"]; + response: Endpoints["DELETE /app/installations/{installation_id}/suspended"]["response"]; + }; + updateWebhookConfigForApp: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /app/hook/config"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /app/hook/config"]["response"]; }; }; billing: { getGithubActionsBillingOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/settings/billing/actions"]["parameters"], + Endpoints["GET /orgs/{org}/settings/billing/actions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/settings/billing/actions"]["response"]; + response: Endpoints["GET /orgs/{org}/settings/billing/actions"]["response"]; }; getGithubActionsBillingUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/settings/billing/actions"]["parameters"], + Endpoints["GET /users/{username}/settings/billing/actions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/settings/billing/actions"]["response"]; + response: Endpoints["GET /users/{username}/settings/billing/actions"]["response"]; }; getGithubPackagesBillingOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/settings/billing/packages"]["parameters"], + Endpoints["GET /orgs/{org}/settings/billing/packages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/settings/billing/packages"]["response"]; + response: Endpoints["GET /orgs/{org}/settings/billing/packages"]["response"]; }; getGithubPackagesBillingUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/settings/billing/packages"]["parameters"], + Endpoints["GET /users/{username}/settings/billing/packages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/settings/billing/packages"]["response"]; + response: Endpoints["GET /users/{username}/settings/billing/packages"]["response"]; }; getSharedStorageBillingOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/settings/billing/shared-storage"]["parameters"], + Endpoints["GET /orgs/{org}/settings/billing/shared-storage"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/settings/billing/shared-storage"]["response"]; + response: Endpoints["GET /orgs/{org}/settings/billing/shared-storage"]["response"]; }; getSharedStorageBillingUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/settings/billing/shared-storage"]["parameters"], + Endpoints["GET /users/{username}/settings/billing/shared-storage"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/settings/billing/shared-storage"]["response"]; + response: Endpoints["GET /users/{username}/settings/billing/shared-storage"]["response"]; }; }; checks: { create: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/check-runs"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/check-runs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/check-runs"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/check-runs"]["response"]; }; createSuite: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/check-suites"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/check-suites"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/check-suites"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/check-runs/:check_run_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/check-runs/:check_run_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; }; getSuite: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/check-suites/:check_suite_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/check-suites/:check_suite_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"]["response"]; }; listAnnotations: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/check-runs/:check_run_id/annotations"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/check-runs/:check_run_id/annotations"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"]; }; listForRef: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:ref/check-runs"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:ref/check-runs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"]; }; listForSuite: { parameters: RequestParameters & Omit< - Endpoints["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"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"]; }; listSuitesForRef: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:ref/check-suites"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:ref/check-suites"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]; }; rerequestSuite: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["response"]; }; setSuitesPreferences: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/check-suites/preferences"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/check-suites/preferences"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/check-suites/preferences"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-suites/preferences"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/check-runs/:check_run_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/check-runs/:check_run_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; }; }; codeScanning: { getAlert: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/code-scanning/alerts/:alert_number"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/code-scanning/alerts/:alert_number"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; }; listAlertsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/code-scanning/alerts"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/code-scanning/alerts"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"]; }; listRecentAnalyses: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/code-scanning/analyses"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/code-scanning/analyses"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"]; }; updateAlert: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; }; uploadSarif: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/code-scanning/sarifs"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/code-scanning/sarifs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/code-scanning/sarifs"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/code-scanning/sarifs"]["response"]; }; }; codesOfConduct: { @@ -1073,18 +1209,18 @@ export type RestEndpointMethodTypes = { getConductCode: { parameters: RequestParameters & Omit< - Endpoints["GET /codes_of_conduct/:key"]["parameters"], + Endpoints["GET /codes_of_conduct/{key}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /codes_of_conduct/:key"]["response"]; + response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; }; getForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/community/code_of_conduct"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/community/code_of_conduct"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["response"]; }; }; emojis: { @@ -1097,14 +1233,80 @@ export type RestEndpointMethodTypes = { response: Endpoints["GET /emojis"]["response"]; }; }; + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + enableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + getAllowedActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + getGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + listSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + setAllowedActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + setSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + }; gists: { checkIsStarred: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/star"]["parameters"], + Endpoints["GET /gists/{gist_id}/star"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/star"]["response"]; + response: Endpoints["GET /gists/{gist_id}/star"]["response"]; }; create: { parameters: RequestParameters & @@ -1117,58 +1319,58 @@ export type RestEndpointMethodTypes = { createComment: { parameters: RequestParameters & Omit< - Endpoints["POST /gists/:gist_id/comments"]["parameters"], + Endpoints["POST /gists/{gist_id}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /gists/:gist_id/comments"]["response"]; + response: Endpoints["POST /gists/{gist_id}/comments"]["response"]; }; delete: { parameters: RequestParameters & Omit< - Endpoints["DELETE /gists/:gist_id"]["parameters"], + Endpoints["DELETE /gists/{gist_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /gists/:gist_id"]["response"]; + response: Endpoints["DELETE /gists/{gist_id}"]["response"]; }; deleteComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /gists/:gist_id/comments/:comment_id"]["parameters"], + Endpoints["DELETE /gists/{gist_id}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /gists/:gist_id/comments/:comment_id"]["response"]; + response: Endpoints["DELETE /gists/{gist_id}/comments/{comment_id}"]["response"]; }; fork: { parameters: RequestParameters & Omit< - Endpoints["POST /gists/:gist_id/forks"]["parameters"], + Endpoints["POST /gists/{gist_id}/forks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /gists/:gist_id/forks"]["response"]; + response: Endpoints["POST /gists/{gist_id}/forks"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id"]["parameters"], + Endpoints["GET /gists/{gist_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id"]["response"]; + response: Endpoints["GET /gists/{gist_id}"]["response"]; }; getComment: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/comments/:comment_id"]["parameters"], + Endpoints["GET /gists/{gist_id}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/comments/:comment_id"]["response"]; + response: Endpoints["GET /gists/{gist_id}/comments/{comment_id}"]["response"]; }; getRevision: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/:sha"]["parameters"], + Endpoints["GET /gists/{gist_id}/{sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/:sha"]["response"]; + response: Endpoints["GET /gists/{gist_id}/{sha}"]["response"]; }; list: { parameters: RequestParameters & @@ -1181,34 +1383,34 @@ export type RestEndpointMethodTypes = { listComments: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/comments"]["parameters"], + Endpoints["GET /gists/{gist_id}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/comments"]["response"]; + response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; }; listCommits: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/commits"]["parameters"], + Endpoints["GET /gists/{gist_id}/commits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/commits"]["response"]; + response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; }; listForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/gists"]["parameters"], + Endpoints["GET /users/{username}/gists"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/gists"]["response"]; + response: Endpoints["GET /users/{username}/gists"]["response"]; }; listForks: { parameters: RequestParameters & Omit< - Endpoints["GET /gists/:gist_id/forks"]["parameters"], + Endpoints["GET /gists/{gist_id}/forks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gists/:gist_id/forks"]["response"]; + response: Endpoints["GET /gists/{gist_id}/forks"]["response"]; }; listPublic: { parameters: RequestParameters & @@ -1229,140 +1431,140 @@ export type RestEndpointMethodTypes = { star: { parameters: RequestParameters & Omit< - Endpoints["PUT /gists/:gist_id/star"]["parameters"], + Endpoints["PUT /gists/{gist_id}/star"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /gists/:gist_id/star"]["response"]; + response: Endpoints["PUT /gists/{gist_id}/star"]["response"]; }; unstar: { parameters: RequestParameters & Omit< - Endpoints["DELETE /gists/:gist_id/star"]["parameters"], + Endpoints["DELETE /gists/{gist_id}/star"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /gists/:gist_id/star"]["response"]; + response: Endpoints["DELETE /gists/{gist_id}/star"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /gists/:gist_id"]["parameters"], + Endpoints["PATCH /gists/{gist_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /gists/:gist_id"]["response"]; + response: Endpoints["PATCH /gists/{gist_id}"]["response"]; }; updateComment: { parameters: RequestParameters & Omit< - Endpoints["PATCH /gists/:gist_id/comments/:comment_id"]["parameters"], + Endpoints["PATCH /gists/{gist_id}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /gists/:gist_id/comments/:comment_id"]["response"]; + response: Endpoints["PATCH /gists/{gist_id}/comments/{comment_id}"]["response"]; }; }; git: { createBlob: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/git/blobs"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/git/blobs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/git/blobs"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/git/blobs"]["response"]; }; createCommit: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/git/commits"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/git/commits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/git/commits"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/git/commits"]["response"]; }; createRef: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/git/refs"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/git/refs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/git/refs"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/git/refs"]["response"]; }; createTag: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/git/tags"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/git/tags"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/git/tags"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/git/tags"]["response"]; }; createTree: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/git/trees"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/git/trees"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/git/trees"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/git/trees"]["response"]; }; deleteRef: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/git/refs/:ref"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/git/refs/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/git/refs/:ref"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; }; getBlob: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/blobs/:file_sha"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/blobs/:file_sha"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"]["response"]; }; getCommit: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/commits/:commit_sha"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/commits/:commit_sha"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"]["response"]; }; getRef: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/ref/:ref"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/ref/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/ref/:ref"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/ref/{ref}"]["response"]; }; getTag: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/tags/:tag_sha"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/tags/:tag_sha"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"]["response"]; }; getTree: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/trees/:tree_sha"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/trees/:tree_sha"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"]["response"]; }; listMatchingRefs: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/git/matching-refs/:ref"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/git/matching-refs/:ref"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["response"]; }; updateRef: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/git/refs/:ref"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/git/refs/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/git/refs/:ref"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; }; }; gitignore: { @@ -1377,182 +1579,182 @@ export type RestEndpointMethodTypes = { getTemplate: { parameters: RequestParameters & Omit< - Endpoints["GET /gitignore/templates/:name"]["parameters"], + Endpoints["GET /gitignore/templates/{name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /gitignore/templates/:name"]["response"]; + response: Endpoints["GET /gitignore/templates/{name}"]["response"]; }; }; interactions: { getRestrictionsForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/interaction-limits"]["parameters"], + Endpoints["GET /orgs/{org}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/interaction-limits"]["response"]; + response: Endpoints["GET /orgs/{org}/interaction-limits"]["response"]; }; getRestrictionsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/interaction-limits"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/interaction-limits"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/interaction-limits"]["response"]; }; removeRestrictionsForOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/interaction-limits"]["parameters"], + Endpoints["DELETE /orgs/{org}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/interaction-limits"]["response"]; + response: Endpoints["DELETE /orgs/{org}/interaction-limits"]["response"]; }; removeRestrictionsForRepo: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/interaction-limits"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/interaction-limits"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/interaction-limits"]["response"]; }; setRestrictionsForOrg: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/interaction-limits"]["parameters"], + Endpoints["PUT /orgs/{org}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/interaction-limits"]["response"]; + response: Endpoints["PUT /orgs/{org}/interaction-limits"]["response"]; }; setRestrictionsForRepo: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/interaction-limits"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/interaction-limits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/interaction-limits"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/interaction-limits"]["response"]; }; }; issues: { addAssignees: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues/:issue_number/assignees"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues/:issue_number/assignees"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; }; addLabels: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues/:issue_number/labels"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues/:issue_number/labels"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; }; checkUserCanBeAssigned: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/assignees/:assignee"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/assignees/{assignee}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/assignees/:assignee"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/assignees/{assignee}"]["response"]; }; create: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues"]["response"]; }; createComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues/:issue_number/comments"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues/:issue_number/comments"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; }; createLabel: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/labels"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/labels"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/labels"]["response"]; }; createMilestone: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/milestones"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/milestones"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/milestones"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/milestones"]["response"]; }; deleteComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/comments/:comment_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/comments/:comment_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; }; deleteLabel: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/labels/:name"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/labels/{name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/labels/:name"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/labels/{name}"]["response"]; }; deleteMilestone: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/milestones/:milestone_number"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/milestones/:milestone_number"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; }; getComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/comments/:comment_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/comments/:comment_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; }; getEvent: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/events/:event_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/events/{event_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/events/:event_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events/{event_id}"]["response"]; }; getLabel: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/labels/:name"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/labels/{name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/labels/:name"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/labels/{name}"]["response"]; }; getMilestone: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/milestones/:milestone_number"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/milestones/:milestone_number"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; }; list: { parameters: RequestParameters & @@ -1565,50 +1767,50 @@ export type RestEndpointMethodTypes = { listAssignees: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/assignees"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/assignees"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; }; listComments: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; }; listCommentsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; }; listEvents: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number/events"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number/events"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"]; }; listEventsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/events"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/events"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"]; }; listEventsForTimeline: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number/timeline"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number/timeline"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"]; }; listForAuthenticatedUser: { parameters: RequestParameters & @@ -1621,140 +1823,140 @@ export type RestEndpointMethodTypes = { listForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/issues"]["parameters"], + Endpoints["GET /orgs/{org}/issues"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/issues"]["response"]; + response: Endpoints["GET /orgs/{org}/issues"]["response"]; }; listForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"]; }; listLabelsForMilestone: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/milestones/:milestone_number/labels"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/milestones/:milestone_number/labels"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"]; }; listLabelsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/labels"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/labels"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"]; }; listLabelsOnIssue: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number/labels"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number/labels"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; }; listMilestones: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/milestones"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/milestones"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/milestones"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"]; }; lock: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/issues/:issue_number/lock"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/issues/:issue_number/lock"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; }; removeAllLabels: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/labels"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/labels"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; }; removeAssignees: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/assignees"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/assignees"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; }; removeLabel: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"]["response"]; }; setLabels: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/issues/:issue_number/labels"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/issues/:issue_number/labels"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; }; unlock: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/lock"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/lock"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/issues/:issue_number"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/issues/{issue_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/issues/:issue_number"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; }; updateComment: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/issues/comments/:comment_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/issues/comments/:comment_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; }; updateLabel: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/labels/:name"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/labels/{name}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/labels/:name"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/labels/{name}"]["response"]; }; updateMilestone: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/milestones/:milestone_number"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/milestones/:milestone_number"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; }; }; licenses: { get: { parameters: RequestParameters & Omit< - Endpoints["GET /licenses/:license"]["parameters"], + Endpoints["GET /licenses/{license}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /licenses/:license"]["response"]; + response: Endpoints["GET /licenses/{license}"]["response"]; }; getAllCommonlyUsed: { parameters: RequestParameters & @@ -1767,10 +1969,10 @@ export type RestEndpointMethodTypes = { getForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/license"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/license"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/license"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/license"]["response"]; }; }; markdown: { @@ -1800,87 +2002,111 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /meta"]["response"]; }; + getOctocat: { + parameters: RequestParameters & + Omit< + Endpoints["GET /octocat"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /octocat"]["response"]; + }; + getZen: { + parameters: RequestParameters & + Omit< + Endpoints["GET /zen"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /zen"]["response"]; + }; + root: { + parameters: RequestParameters & + Omit< + Endpoints["GET /"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /"]["response"]; + }; }; migrations: { cancelImport: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/import"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/import"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/import"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/import"]["response"]; }; deleteArchiveForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/migrations/:migration_id/archive"]["parameters"], + Endpoints["DELETE /user/migrations/{migration_id}/archive"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/migrations/:migration_id/archive"]["response"]; + response: Endpoints["DELETE /user/migrations/{migration_id}/archive"]["response"]; }; deleteArchiveForOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/migrations/:migration_id/archive"]["parameters"], + Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/archive"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/migrations/:migration_id/archive"]["response"]; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/archive"]["response"]; }; downloadArchiveForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/migrations/:migration_id/archive"]["parameters"], + Endpoints["GET /orgs/{org}/migrations/{migration_id}/archive"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/migrations/:migration_id/archive"]["response"]; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/archive"]["response"]; }; getArchiveForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/migrations/:migration_id/archive"]["parameters"], + Endpoints["GET /user/migrations/{migration_id}/archive"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/migrations/:migration_id/archive"]["response"]; + response: Endpoints["GET /user/migrations/{migration_id}/archive"]["response"]; }; getCommitAuthors: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/import/authors"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/import/authors"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/import/authors"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/import/authors"]["response"]; }; getImportStatus: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/import"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/import"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/import"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/import"]["response"]; }; getLargeFiles: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/import/large_files"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/import/large_files"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/import/large_files"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/import/large_files"]["response"]; }; getStatusForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/migrations/:migration_id"]["parameters"], + Endpoints["GET /user/migrations/{migration_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/migrations/:migration_id"]["response"]; + response: Endpoints["GET /user/migrations/{migration_id}"]["response"]; }; getStatusForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/migrations/:migration_id"]["parameters"], + Endpoints["GET /orgs/{org}/migrations/{migration_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/migrations/:migration_id"]["response"]; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}"]["response"]; }; listForAuthenticatedUser: { parameters: RequestParameters & @@ -1893,42 +2119,42 @@ export type RestEndpointMethodTypes = { listForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/migrations"]["parameters"], + Endpoints["GET /orgs/{org}/migrations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/migrations"]["response"]; + response: Endpoints["GET /orgs/{org}/migrations"]["response"]; }; listReposForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/migrations/:migration_id/repositories"]["parameters"], + Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/migrations/:migration_id/repositories"]["response"]; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; }; listReposForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/migrations/:migration_id/repositories"]["parameters"], + Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/migrations/:migration_id/repositories"]["response"]; + response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; }; mapCommitAuthor: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/import/authors/:author_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/import/authors/:author_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"]["response"]; }; setLfsPreference: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/import/lfs"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/import/lfs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/import/lfs"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/lfs"]["response"]; }; startForAuthenticatedUser: { parameters: RequestParameters & @@ -1941,140 +2167,148 @@ export type RestEndpointMethodTypes = { startForOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/migrations"]["parameters"], + Endpoints["POST /orgs/{org}/migrations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/migrations"]["response"]; + response: Endpoints["POST /orgs/{org}/migrations"]["response"]; }; startImport: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/import"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/import"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/import"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/import"]["response"]; }; unlockRepoForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/migrations/:migration_id/repos/:repo_name/lock"]["parameters"], + Endpoints["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/migrations/:migration_id/repos/:repo_name/lock"]["response"]; + response: Endpoints["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; }; unlockRepoForOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock"]["parameters"], + Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock"]["response"]; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; }; updateImport: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/import"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/import"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/import"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/import"]["response"]; }; }; orgs: { blockUser: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/blocks/:username"]["parameters"], + Endpoints["PUT /orgs/{org}/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/blocks/:username"]["response"]; + response: Endpoints["PUT /orgs/{org}/blocks/{username}"]["response"]; }; checkBlockedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/blocks/:username"]["parameters"], + Endpoints["GET /orgs/{org}/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/blocks/:username"]["response"]; + response: Endpoints["GET /orgs/{org}/blocks/{username}"]["response"]; }; checkMembershipForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/members/:username"]["parameters"], + Endpoints["GET /orgs/{org}/members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/members/:username"]["response"]; + response: Endpoints["GET /orgs/{org}/members/{username}"]["response"]; }; checkPublicMembershipForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/public_members/:username"]["parameters"], + Endpoints["GET /orgs/{org}/public_members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/public_members/:username"]["response"]; + response: Endpoints["GET /orgs/{org}/public_members/{username}"]["response"]; }; convertMemberToOutsideCollaborator: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/outside_collaborators/:username"]["parameters"], + Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/outside_collaborators/:username"]["response"]; + response: Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["response"]; }; createInvitation: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/invitations"]["parameters"], + Endpoints["POST /orgs/{org}/invitations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/invitations"]["response"]; + response: Endpoints["POST /orgs/{org}/invitations"]["response"]; }; createWebhook: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/hooks"]["parameters"], + Endpoints["POST /orgs/{org}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/hooks"]["response"]; + response: Endpoints["POST /orgs/{org}/hooks"]["response"]; }; deleteWebhook: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/hooks/:hook_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/hooks/:hook_id"]["response"]; + response: Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org"]["parameters"], + Endpoints["GET /orgs/{org}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org"]["response"]; + response: Endpoints["GET /orgs/{org}"]["response"]; }; getMembershipForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["GET /user/memberships/orgs/:org"]["parameters"], + Endpoints["GET /user/memberships/orgs/{org}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/memberships/orgs/:org"]["response"]; + response: Endpoints["GET /user/memberships/orgs/{org}"]["response"]; }; getMembershipForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/memberships/:username"]["parameters"], + Endpoints["GET /orgs/{org}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/memberships/:username"]["response"]; + response: Endpoints["GET /orgs/{org}/memberships/{username}"]["response"]; }; getWebhook: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/hooks/:hook_id"]["parameters"], + Endpoints["GET /orgs/{org}/hooks/{hook_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/hooks/:hook_id"]["response"]; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["response"]; }; list: { parameters: RequestParameters & @@ -2087,18 +2321,18 @@ export type RestEndpointMethodTypes = { listAppInstallations: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/installations"]["parameters"], + Endpoints["GET /orgs/{org}/installations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/installations"]["response"]; + response: Endpoints["GET /orgs/{org}/installations"]["response"]; }; listBlockedUsers: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/blocks"]["parameters"], + Endpoints["GET /orgs/{org}/blocks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/blocks"]["response"]; + response: Endpoints["GET /orgs/{org}/blocks"]["response"]; }; listForAuthenticatedUser: { parameters: RequestParameters & @@ -2111,26 +2345,26 @@ export type RestEndpointMethodTypes = { listForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/orgs"]["parameters"], + Endpoints["GET /users/{username}/orgs"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/orgs"]["response"]; + response: Endpoints["GET /users/{username}/orgs"]["response"]; }; listInvitationTeams: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/invitations/:invitation_id/teams"]["parameters"], + Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/invitations/:invitation_id/teams"]["response"]; + response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; }; listMembers: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/members"]["parameters"], + Endpoints["GET /orgs/{org}/members"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/members"]["response"]; + response: Endpoints["GET /orgs/{org}/members"]["response"]; }; listMembershipsForAuthenticatedUser: { parameters: RequestParameters & @@ -2143,148 +2377,156 @@ export type RestEndpointMethodTypes = { listOutsideCollaborators: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/outside_collaborators"]["parameters"], + Endpoints["GET /orgs/{org}/outside_collaborators"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/outside_collaborators"]["response"]; + response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; }; listPendingInvitations: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/invitations"]["parameters"], + Endpoints["GET /orgs/{org}/invitations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/invitations"]["response"]; + response: Endpoints["GET /orgs/{org}/invitations"]["response"]; }; listPublicMembers: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/public_members"]["parameters"], + Endpoints["GET /orgs/{org}/public_members"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/public_members"]["response"]; + response: Endpoints["GET /orgs/{org}/public_members"]["response"]; }; listWebhooks: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/hooks"]["parameters"], + Endpoints["GET /orgs/{org}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/hooks"]["response"]; + response: Endpoints["GET /orgs/{org}/hooks"]["response"]; }; pingWebhook: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/hooks/:hook_id/pings"]["parameters"], + Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/hooks/:hook_id/pings"]["response"]; + response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["response"]; }; removeMember: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/members/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/members/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/members/{username}"]["response"]; }; removeMembershipForUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/memberships/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/memberships/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/memberships/{username}"]["response"]; }; removeOutsideCollaborator: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/outside_collaborators/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/outside_collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/outside_collaborators/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/outside_collaborators/{username}"]["response"]; }; removePublicMembershipForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/public_members/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/public_members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/public_members/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/public_members/{username}"]["response"]; }; setMembershipForUser: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/memberships/:username"]["parameters"], + Endpoints["PUT /orgs/{org}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/memberships/:username"]["response"]; + response: Endpoints["PUT /orgs/{org}/memberships/{username}"]["response"]; }; setPublicMembershipForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/public_members/:username"]["parameters"], + Endpoints["PUT /orgs/{org}/public_members/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/public_members/:username"]["response"]; + response: Endpoints["PUT /orgs/{org}/public_members/{username}"]["response"]; }; unblockUser: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/blocks/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/blocks/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/blocks/{username}"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /orgs/:org"]["parameters"], + Endpoints["PATCH /orgs/{org}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /orgs/:org"]["response"]; + response: Endpoints["PATCH /orgs/{org}"]["response"]; }; updateMembershipForAuthenticatedUser: { parameters: RequestParameters & Omit< - Endpoints["PATCH /user/memberships/orgs/:org"]["parameters"], + Endpoints["PATCH /user/memberships/orgs/{org}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /user/memberships/orgs/:org"]["response"]; + response: Endpoints["PATCH /user/memberships/orgs/{org}"]["response"]; }; updateWebhook: { parameters: RequestParameters & Omit< - Endpoints["PATCH /orgs/:org/hooks/:hook_id"]["parameters"], + Endpoints["PATCH /orgs/{org}/hooks/{hook_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /orgs/:org/hooks/:hook_id"]["response"]; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /orgs/{org}/hooks/{hook_id}/config"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}/config"]["response"]; }; }; projects: { addCollaborator: { parameters: RequestParameters & Omit< - Endpoints["PUT /projects/:project_id/collaborators/:username"]["parameters"], + Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /projects/:project_id/collaborators/:username"]["response"]; + response: Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["response"]; }; createCard: { parameters: RequestParameters & Omit< - Endpoints["POST /projects/columns/:column_id/cards"]["parameters"], + Endpoints["POST /projects/columns/{column_id}/cards"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /projects/columns/:column_id/cards"]["response"]; + response: Endpoints["POST /projects/columns/{column_id}/cards"]["response"]; }; createColumn: { parameters: RequestParameters & Omit< - Endpoints["POST /projects/:project_id/columns"]["parameters"], + Endpoints["POST /projects/{project_id}/columns"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /projects/:project_id/columns"]["response"]; + response: Endpoints["POST /projects/{project_id}/columns"]["response"]; }; createForAuthenticatedUser: { parameters: RequestParameters & @@ -2297,388 +2539,388 @@ export type RestEndpointMethodTypes = { createForOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/projects"]["parameters"], + Endpoints["POST /orgs/{org}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/projects"]["response"]; + response: Endpoints["POST /orgs/{org}/projects"]["response"]; }; createForRepo: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/projects"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/projects"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/projects"]["response"]; }; delete: { parameters: RequestParameters & Omit< - Endpoints["DELETE /projects/:project_id"]["parameters"], + Endpoints["DELETE /projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /projects/:project_id"]["response"]; + response: Endpoints["DELETE /projects/{project_id}"]["response"]; }; deleteCard: { parameters: RequestParameters & Omit< - Endpoints["DELETE /projects/columns/cards/:card_id"]["parameters"], + Endpoints["DELETE /projects/columns/cards/{card_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /projects/columns/cards/:card_id"]["response"]; + response: Endpoints["DELETE /projects/columns/cards/{card_id}"]["response"]; }; deleteColumn: { parameters: RequestParameters & Omit< - Endpoints["DELETE /projects/columns/:column_id"]["parameters"], + Endpoints["DELETE /projects/columns/{column_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /projects/columns/:column_id"]["response"]; + response: Endpoints["DELETE /projects/columns/{column_id}"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/:project_id"]["parameters"], + Endpoints["GET /projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/:project_id"]["response"]; + response: Endpoints["GET /projects/{project_id}"]["response"]; }; getCard: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/columns/cards/:card_id"]["parameters"], + Endpoints["GET /projects/columns/cards/{card_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/columns/cards/:card_id"]["response"]; + response: Endpoints["GET /projects/columns/cards/{card_id}"]["response"]; }; getColumn: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/columns/:column_id"]["parameters"], + Endpoints["GET /projects/columns/{column_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/columns/:column_id"]["response"]; + response: Endpoints["GET /projects/columns/{column_id}"]["response"]; }; getPermissionForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/:project_id/collaborators/:username/permission"]["parameters"], + Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/:project_id/collaborators/:username/permission"]["response"]; + response: Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["response"]; }; listCards: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/columns/:column_id/cards"]["parameters"], + Endpoints["GET /projects/columns/{column_id}/cards"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/columns/:column_id/cards"]["response"]; + response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; }; listCollaborators: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/:project_id/collaborators"]["parameters"], + Endpoints["GET /projects/{project_id}/collaborators"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/:project_id/collaborators"]["response"]; + response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; }; listColumns: { parameters: RequestParameters & Omit< - Endpoints["GET /projects/:project_id/columns"]["parameters"], + Endpoints["GET /projects/{project_id}/columns"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /projects/:project_id/columns"]["response"]; + response: Endpoints["GET /projects/{project_id}/columns"]["response"]; }; listForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/projects"]["parameters"], + Endpoints["GET /orgs/{org}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/projects"]["response"]; + response: Endpoints["GET /orgs/{org}/projects"]["response"]; }; listForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/projects"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/projects"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; }; listForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/projects"]["parameters"], + Endpoints["GET /users/{username}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/projects"]["response"]; + response: Endpoints["GET /users/{username}/projects"]["response"]; }; moveCard: { parameters: RequestParameters & Omit< - Endpoints["POST /projects/columns/cards/:card_id/moves"]["parameters"], + Endpoints["POST /projects/columns/cards/{card_id}/moves"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /projects/columns/cards/:card_id/moves"]["response"]; + response: Endpoints["POST /projects/columns/cards/{card_id}/moves"]["response"]; }; moveColumn: { parameters: RequestParameters & Omit< - Endpoints["POST /projects/columns/:column_id/moves"]["parameters"], + Endpoints["POST /projects/columns/{column_id}/moves"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /projects/columns/:column_id/moves"]["response"]; + response: Endpoints["POST /projects/columns/{column_id}/moves"]["response"]; }; removeCollaborator: { parameters: RequestParameters & Omit< - Endpoints["DELETE /projects/:project_id/collaborators/:username"]["parameters"], + Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /projects/:project_id/collaborators/:username"]["response"]; + response: Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /projects/:project_id"]["parameters"], + Endpoints["PATCH /projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /projects/:project_id"]["response"]; + response: Endpoints["PATCH /projects/{project_id}"]["response"]; }; updateCard: { parameters: RequestParameters & Omit< - Endpoints["PATCH /projects/columns/cards/:card_id"]["parameters"], + Endpoints["PATCH /projects/columns/cards/{card_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /projects/columns/cards/:card_id"]["response"]; + response: Endpoints["PATCH /projects/columns/cards/{card_id}"]["response"]; }; updateColumn: { parameters: RequestParameters & Omit< - Endpoints["PATCH /projects/columns/:column_id"]["parameters"], + Endpoints["PATCH /projects/columns/{column_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /projects/columns/:column_id"]["response"]; + response: Endpoints["PATCH /projects/columns/{column_id}"]["response"]; }; }; pulls: { checkIfMerged: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/merge"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/merge"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; }; create: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls"]["response"]; }; createReplyForReviewComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"]["response"]; }; createReview: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/reviews"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/reviews"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; }; createReviewComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/comments"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/comments"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; }; deletePendingReview: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; }; deleteReviewComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/pulls/comments/:comment_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/pulls/comments/:comment_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; }; dismissReview: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; }; getReview: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; }; getReviewComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/comments/:comment_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/comments/:comment_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; }; list: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"]; }; listCommentsForReview: { parameters: RequestParameters & Omit< - Endpoints["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"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"]; }; listCommits: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/commits"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/commits"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; }; listFiles: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/files"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/files"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"]; }; listRequestedReviewers: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; }; listReviewComments: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; }; listReviewCommentsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; }; listReviews: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/reviews"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/:pull_number/reviews"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; }; merge: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/merge"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/merge"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; }; removeRequestedReviewers: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; }; requestReviewers: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; }; submitReview: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/pulls/:pull_number"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/pulls/:pull_number"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; }; updateBranch: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/update-branch"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/update-branch"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch"]["response"]; }; updateReview: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; }; updateReviewComment: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/pulls/comments/:comment_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/pulls/comments/:comment_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; }; }; rateLimit: { @@ -2695,284 +2937,284 @@ export type RestEndpointMethodTypes = { createForCommitComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/comments/:comment_id/reactions"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/comments/:comment_id/reactions"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; }; createForIssue: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues/:issue_number/reactions"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues/:issue_number/reactions"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; }; createForIssueComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/issues/comments/:comment_id/reactions"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/issues/comments/:comment_id/reactions"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; }; createForPullRequestReviewComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; }; createForTeamDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"]["parameters"], + Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"]["response"]; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; }; createForTeamDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"]["parameters"], + Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"]["response"]; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; }; deleteForCommitComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"]["response"]; }; deleteForIssue: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"]["response"]; }; deleteForIssueComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"]["response"]; }; deleteForPullRequestComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"]["response"]; }; deleteForTeamDiscussion: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"]["response"]; }; deleteForTeamDiscussionComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"]; }; deleteLegacy: { parameters: RequestParameters & Omit< - Endpoints["DELETE /reactions/:reaction_id"]["parameters"], + Endpoints["DELETE /reactions/{reaction_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /reactions/:reaction_id"]["response"]; + response: Endpoints["DELETE /reactions/{reaction_id}"]["response"]; }; listForCommitComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/comments/:comment_id/reactions"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/comments/:comment_id/reactions"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; }; listForIssue: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/:issue_number/reactions"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/:issue_number/reactions"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; }; listForIssueComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/issues/comments/:comment_id/reactions"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/issues/comments/:comment_id/reactions"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; }; listForPullRequestReviewComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; }; listForTeamDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["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"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; }; listForTeamDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; }; }; repos: { acceptInvitation: { parameters: RequestParameters & Omit< - Endpoints["PATCH /user/repository_invitations/:invitation_id"]["parameters"], + Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /user/repository_invitations/:invitation_id"]["response"]; + response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"]; }; addAppAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; }; addCollaborator: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/collaborators/:username"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/collaborators/:username"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/collaborators/{username}"]["response"]; }; addStatusCheckContexts: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; }; addTeamAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; }; addUserAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; checkCollaborator: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/collaborators/:username"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/collaborators/:username"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["response"]; }; checkVulnerabilityAlerts: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/vulnerability-alerts"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/vulnerability-alerts"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; }; compareCommits: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/compare/:base...:head"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/compare/{base}...{head}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/compare/:base...:head"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/compare/{base}...{head}"]["response"]; }; createCommitComment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/commits/:commit_sha/comments"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/commits/:commit_sha/comments"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; }; createCommitSignatureProtection: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; }; createCommitStatus: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/statuses/:sha"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/statuses/{sha}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/statuses/:sha"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/statuses/{sha}"]["response"]; }; createDeployKey: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/keys"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/keys"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/keys"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/keys"]["response"]; }; createDeployment: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/deployments"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/deployments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/deployments"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/deployments"]["response"]; }; createDeploymentStatus: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/deployments/:deployment_id/statuses"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/deployments/:deployment_id/statuses"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; }; createDispatchEvent: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/dispatches"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/dispatches"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/dispatches"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/dispatches"]["response"]; }; createForAuthenticatedUser: { parameters: RequestParameters & @@ -2985,634 +3227,658 @@ export type RestEndpointMethodTypes = { createFork: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/forks"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/forks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/forks"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/forks"]["response"]; }; createInOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/repos"]["parameters"], + Endpoints["POST /orgs/{org}/repos"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/repos"]["response"]; + response: Endpoints["POST /orgs/{org}/repos"]["response"]; }; createOrUpdateFileContents: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/contents/:path"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/contents/{path}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/contents/:path"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/contents/{path}"]["response"]; }; createPagesSite: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pages"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pages"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pages"]["response"]; }; createRelease: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/releases"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/releases"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/releases"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/releases"]["response"]; }; createUsingTemplate: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:template_owner/:template_repo/generate"]["parameters"], + Endpoints["POST /repos/{template_owner}/{template_repo}/generate"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:template_owner/:template_repo/generate"]["response"]; + response: Endpoints["POST /repos/{template_owner}/{template_repo}/generate"]["response"]; }; createWebhook: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/hooks"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/hooks"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/hooks"]["response"]; }; declineInvitation: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/repository_invitations/:invitation_id"]["parameters"], + Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/repository_invitations/:invitation_id"]["response"]; + response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"]; }; delete: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}"]["response"]; }; deleteAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; }; deleteAdminBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; }; deleteBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; }; deleteCommitComment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/comments/:comment_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/comments/:comment_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; }; deleteCommitSignatureProtection: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; }; deleteDeployKey: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/keys/:key_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/keys/:key_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/keys/{key_id}"]["response"]; }; deleteDeployment: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/deployments/:deployment_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/deployments/:deployment_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; }; deleteFile: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/contents/:path"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/contents/{path}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/contents/:path"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/contents/{path}"]["response"]; }; deleteInvitation: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/invitations/:invitation_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/invitations/:invitation_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; }; deletePagesSite: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/pages"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/pages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/pages"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/pages"]["response"]; }; deletePullRequestReviewProtection: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; }; deleteRelease: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/releases/:release_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/releases/:release_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}"]["response"]; }; deleteReleaseAsset: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/releases/assets/:asset_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/releases/assets/:asset_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; }; deleteWebhook: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/hooks/:hook_id"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/hooks/:hook_id"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; }; disableAutomatedSecurityFixes: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/automated-security-fixes"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/automated-security-fixes"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["response"]; }; disableVulnerabilityAlerts: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/vulnerability-alerts"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/vulnerability-alerts"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; }; downloadArchive: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/:archive_format/:ref"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; + }; + downloadTarballArchive: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/tarball/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/:archive_format/:ref"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/tarball/{ref}"]["response"]; + }; + downloadZipballArchive: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; }; enableAutomatedSecurityFixes: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/automated-security-fixes"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/automated-security-fixes"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"]; }; enableVulnerabilityAlerts: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/vulnerability-alerts"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/vulnerability-alerts"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; }; get: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}"]["response"]; }; getAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; }; getAdminBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; }; getAllStatusCheckContexts: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; }; getAllTopics: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/topics"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/topics"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/topics"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/topics"]["response"]; }; getAppsWithAccessToProtectedBranch: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; }; getBranch: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["response"]; }; getBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; }; getClones: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/traffic/clones"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/traffic/clones"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/traffic/clones"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/clones"]["response"]; }; getCodeFrequencyStats: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stats/code_frequency"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stats/code_frequency"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stats/code_frequency"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stats/code_frequency"]["response"]; }; getCollaboratorPermissionLevel: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/collaborators/:username/permission"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}/permission"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/collaborators/:username/permission"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}/permission"]["response"]; }; getCombinedStatusForRef: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:ref/status"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/status"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:ref/status"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/status"]["response"]; }; getCommit: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:ref"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:ref"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"]["response"]; }; getCommitActivityStats: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stats/commit_activity"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stats/commit_activity"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stats/commit_activity"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stats/commit_activity"]["response"]; }; getCommitComment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/comments/:comment_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/comments/:comment_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; }; getCommitSignatureProtection: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_signatures"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; }; getCommunityProfileMetrics: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/community/profile"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/community/profile"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/community/profile"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/community/profile"]["response"]; }; getContent: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/contents/:path"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/contents/{path}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/contents/:path"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/contents/{path}"]["response"]; }; getContributorsStats: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stats/contributors"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stats/contributors"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stats/contributors"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stats/contributors"]["response"]; }; getDeployKey: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/keys/:key_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/keys/:key_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/keys/{key_id}"]["response"]; }; getDeployment: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; }; getDeploymentStatus: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"]["response"]; }; getLatestPagesBuild: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pages/builds/latest"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pages/builds/latest"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pages/builds/latest"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/latest"]["response"]; }; getLatestRelease: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases/latest"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases/latest"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["response"]; }; getPages: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pages"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pages"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages"]["response"]; }; getPagesBuild: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pages/builds/:build_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pages/builds/:build_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["response"]; }; getParticipationStats: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stats/participation"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stats/participation"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stats/participation"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stats/participation"]["response"]; }; getPullRequestReviewProtection: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; }; getPunchCardStats: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/stats/punch_card"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/stats/punch_card"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/stats/punch_card"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/stats/punch_card"]["response"]; }; getReadme: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/readme"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/readme"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/readme"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/readme"]["response"]; }; getRelease: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases/:release_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases/:release_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}"]["response"]; }; getReleaseAsset: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases/assets/:asset_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases/assets/:asset_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; }; getReleaseByTag: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases/tags/:tag"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases/tags/{tag}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases/tags/:tag"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/tags/{tag}"]["response"]; }; getStatusChecksProtection: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; }; getTeamsWithAccessToProtectedBranch: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; }; getTopPaths: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/traffic/popular/paths"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/traffic/popular/paths"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/traffic/popular/paths"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/paths"]["response"]; }; getTopReferrers: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/traffic/popular/referrers"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/traffic/popular/referrers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/traffic/popular/referrers"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/referrers"]["response"]; }; getUsersWithAccessToProtectedBranch: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; getViews: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/traffic/views"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/traffic/views"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/traffic/views"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/views"]["response"]; }; getWebhook: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/hooks/:hook_id"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/hooks/:hook_id"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; }; listBranches: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/branches"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/branches"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; }; listBranchesForHeadCommit: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["response"]; }; listCollaborators: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/collaborators"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/collaborators"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/collaborators"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["response"]; }; listCommentsForCommit: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; }; listCommitCommentsForRepo: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/comments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/comments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; }; listCommitStatusesForRef: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:ref/statuses"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:ref/statuses"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; }; listCommits: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits"]["response"]; }; listContributors: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/contributors"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/contributors"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"]; }; listDeployKeys: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/keys"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/keys"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/keys"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"]; }; listDeploymentStatuses: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id/statuses"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/deployments/:deployment_id/statuses"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; }; listDeployments: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/deployments"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/deployments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/deployments"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"]; }; listForAuthenticatedUser: { parameters: RequestParameters & @@ -3625,34 +3891,34 @@ export type RestEndpointMethodTypes = { listForOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/repos"]["parameters"], + Endpoints["GET /orgs/{org}/repos"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/repos"]["response"]; + response: Endpoints["GET /orgs/{org}/repos"]["response"]; }; listForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/repos"]["parameters"], + Endpoints["GET /users/{username}/repos"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/repos"]["response"]; + response: Endpoints["GET /users/{username}/repos"]["response"]; }; listForks: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/forks"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/forks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/forks"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"]; }; listInvitations: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/invitations"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/invitations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/invitations"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; }; listInvitationsForAuthenticatedUser: { parameters: RequestParameters & @@ -3665,18 +3931,18 @@ export type RestEndpointMethodTypes = { listLanguages: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/languages"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/languages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/languages"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/languages"]["response"]; }; listPagesBuilds: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/pages/builds"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/pages/builds"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; }; listPublic: { parameters: RequestParameters & @@ -3689,274 +3955,290 @@ export type RestEndpointMethodTypes = { listPullRequestsAssociatedWithCommit: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/pulls"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/commits/:commit_sha/pulls"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"]; }; listReleaseAssets: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases/:release_id/assets"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases/:release_id/assets"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"]; }; listReleases: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/releases"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/releases"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/releases"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; }; listTags: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/tags"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/tags"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; }; listTeams: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/teams"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/teams"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; }; listWebhooks: { parameters: RequestParameters & Omit< - Endpoints["GET /repos/:owner/:repo/hooks"]["parameters"], + Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /repos/:owner/:repo/hooks"]["response"]; + response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; }; merge: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/merges"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/merges"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/merges"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"]; }; pingWebhook: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/hooks/:hook_id/pings"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/hooks/:hook_id/pings"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["response"]; }; removeAppAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; }; removeCollaborator: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/collaborators/:username"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/collaborators/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/collaborators/:username"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/collaborators/{username}"]["response"]; }; removeStatusCheckContexts: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; }; removeStatusCheckProtection: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; }; removeTeamAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; }; removeUserAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; replaceAllTopics: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/topics"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/topics"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/topics"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/topics"]["response"]; }; requestPagesBuild: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/pages/builds"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/pages/builds"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/pages/builds"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/pages/builds"]["response"]; }; setAdminBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; }; setAppAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; }; setStatusCheckContexts: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; }; setTeamAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; }; setUserAccessRestrictions: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; testPushWebhook: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/hooks/:hook_id/tests"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/hooks/:hook_id/tests"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"]["response"]; }; transfer: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/transfer"]["parameters"], + Endpoints["POST /repos/{owner}/{repo}/transfer"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/transfer"]["response"]; + response: Endpoints["POST /repos/{owner}/{repo}/transfer"]["response"]; }; update: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}"]["response"]; }; updateBranchProtection: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/branches/:branch/protection"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; }; updateCommitComment: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/comments/:comment_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/comments/{comment_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/comments/:comment_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; }; updateInformationAboutPagesSite: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/:owner/:repo/pages"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/pages"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/:owner/:repo/pages"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/pages"]["response"]; }; updateInvitation: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/invitations/:invitation_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/invitations/:invitation_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; }; updatePullRequestReviewProtection: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; }; updateRelease: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/releases/:release_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/releases/{release_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/releases/:release_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/{release_id}"]["response"]; }; updateReleaseAsset: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/releases/assets/:asset_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/releases/assets/:asset_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; }; updateStatusCheckPotection: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + updateStatusCheckProtection: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; }; updateWebhook: { parameters: RequestParameters & Omit< - Endpoints["PATCH /repos/:owner/:repo/hooks/:hook_id"]["parameters"], + Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /repos/:owner/:repo/hooks/:hook_id"]["response"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; }; uploadReleaseAsset: { parameters: RequestParameters & Omit< - Endpoints["POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}"]["parameters"], + Endpoints["POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}"]["response"]; + response: Endpoints["POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}"]["response"]; }; }; search: { @@ -4021,154 +4303,154 @@ export type RestEndpointMethodTypes = { addOrUpdateMembershipForUserInOrg: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/teams/:team_slug/memberships/:username"]["parameters"], + Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/teams/:team_slug/memberships/:username"]["response"]; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; }; addOrUpdateProjectPermissionsInOrg: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/teams/:team_slug/projects/:project_id"]["parameters"], + Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/teams/:team_slug/projects/:project_id"]["response"]; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; }; addOrUpdateRepoPermissionsInOrg: { parameters: RequestParameters & Omit< - Endpoints["PUT /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["parameters"], + Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["response"]; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; }; checkPermissionsForProjectInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/projects/:project_id"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/projects/:project_id"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; }; checkPermissionsForRepoInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; }; create: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/teams"]["parameters"], + Endpoints["POST /orgs/{org}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/teams"]["response"]; + response: Endpoints["POST /orgs/{org}/teams"]["response"]; }; createDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"]["parameters"], + Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"]["response"]; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; }; createDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["POST /orgs/:org/teams/:team_slug/discussions"]["parameters"], + Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /orgs/:org/teams/:team_slug/discussions"]["response"]; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions"]["response"]; }; deleteDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; }; deleteDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; }; deleteInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}"]["response"]; }; getByName: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}"]["response"]; }; getDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; }; getDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; }; getMembershipForUserInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/memberships/:username"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/memberships/:username"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; }; list: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams"]["parameters"], + Endpoints["GET /orgs/{org}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams"]["response"]; + response: Endpoints["GET /orgs/{org}/teams"]["response"]; }; listChildInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/teams"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/teams"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"]; }; listDiscussionCommentsInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; }; listDiscussionsInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/discussions"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/discussions"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"]; }; listForAuthenticatedUser: { parameters: RequestParameters & @@ -4181,82 +4463,82 @@ export type RestEndpointMethodTypes = { listMembersInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/members"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/members"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; }; listPendingInvitationsInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/invitations"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/invitations"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; }; listProjectsInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/projects"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/projects"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; }; listReposInOrg: { parameters: RequestParameters & Omit< - Endpoints["GET /orgs/:org/teams/:team_slug/repos"]["parameters"], + Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /orgs/:org/teams/:team_slug/repos"]["response"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"]; }; removeMembershipForUserInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/memberships/:username"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/memberships/:username"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; }; removeProjectInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/projects/:project_id"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/projects/:project_id"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; }; removeRepoInOrg: { parameters: RequestParameters & Omit< - Endpoints["DELETE /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["parameters"], + Endpoints["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /orgs/:org/teams/:team_slug/repos/:owner/:repo"]["response"]; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; }; updateDiscussionCommentInOrg: { parameters: RequestParameters & Omit< - Endpoints["PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["parameters"], + Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"]["response"]; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; }; updateDiscussionInOrg: { parameters: RequestParameters & Omit< - Endpoints["PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["parameters"], + Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number"]["response"]; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; }; updateInOrg: { parameters: RequestParameters & Omit< - Endpoints["PATCH /orgs/:org/teams/:team_slug"]["parameters"], + Endpoints["PATCH /orgs/{org}/teams/{team_slug}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PATCH /orgs/:org/teams/:team_slug"]["response"]; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}"]["response"]; }; }; users: { @@ -4271,34 +4553,34 @@ export type RestEndpointMethodTypes = { block: { parameters: RequestParameters & Omit< - Endpoints["PUT /user/blocks/:username"]["parameters"], + Endpoints["PUT /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /user/blocks/:username"]["response"]; + response: Endpoints["PUT /user/blocks/{username}"]["response"]; }; checkBlocked: { parameters: RequestParameters & Omit< - Endpoints["GET /user/blocks/:username"]["parameters"], + Endpoints["GET /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/blocks/:username"]["response"]; + response: Endpoints["GET /user/blocks/{username}"]["response"]; }; checkFollowingForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/following/:target_user"]["parameters"], + Endpoints["GET /users/{username}/following/{target_user}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/following/:target_user"]["response"]; + response: Endpoints["GET /users/{username}/following/{target_user}"]["response"]; }; checkPersonIsFollowedByAuthenticated: { parameters: RequestParameters & Omit< - Endpoints["GET /user/following/:username"]["parameters"], + Endpoints["GET /user/following/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/following/:username"]["response"]; + response: Endpoints["GET /user/following/{username}"]["response"]; }; createGpgKeyForAuthenticated: { parameters: RequestParameters & @@ -4327,26 +4609,26 @@ export type RestEndpointMethodTypes = { deleteGpgKeyForAuthenticated: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/gpg_keys/:gpg_key_id"]["parameters"], + Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/gpg_keys/:gpg_key_id"]["response"]; + response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"]; }; deletePublicSshKeyForAuthenticated: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/keys/:key_id"]["parameters"], + Endpoints["DELETE /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/keys/:key_id"]["response"]; + response: Endpoints["DELETE /user/keys/{key_id}"]["response"]; }; follow: { parameters: RequestParameters & Omit< - Endpoints["PUT /user/following/:username"]["parameters"], + Endpoints["PUT /user/following/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /user/following/:username"]["response"]; + response: Endpoints["PUT /user/following/{username}"]["response"]; }; getAuthenticated: { parameters: RequestParameters & @@ -4359,34 +4641,34 @@ export type RestEndpointMethodTypes = { getByUsername: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username"]["parameters"], + Endpoints["GET /users/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username"]["response"]; + response: Endpoints["GET /users/{username}"]["response"]; }; getContextForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/hovercard"]["parameters"], + Endpoints["GET /users/{username}/hovercard"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/hovercard"]["response"]; + response: Endpoints["GET /users/{username}/hovercard"]["response"]; }; getGpgKeyForAuthenticated: { parameters: RequestParameters & Omit< - Endpoints["GET /user/gpg_keys/:gpg_key_id"]["parameters"], + Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/gpg_keys/:gpg_key_id"]["response"]; + response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"]; }; getPublicSshKeyForAuthenticated: { parameters: RequestParameters & Omit< - Endpoints["GET /user/keys/:key_id"]["parameters"], + Endpoints["GET /user/keys/{key_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /user/keys/:key_id"]["response"]; + response: Endpoints["GET /user/keys/{key_id}"]["response"]; }; list: { parameters: RequestParameters & @@ -4431,18 +4713,18 @@ export type RestEndpointMethodTypes = { listFollowersForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/followers"]["parameters"], + Endpoints["GET /users/{username}/followers"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/followers"]["response"]; + response: Endpoints["GET /users/{username}/followers"]["response"]; }; listFollowingForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/following"]["parameters"], + Endpoints["GET /users/{username}/following"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/following"]["response"]; + response: Endpoints["GET /users/{username}/following"]["response"]; }; listGpgKeysForAuthenticated: { parameters: RequestParameters & @@ -4455,10 +4737,10 @@ export type RestEndpointMethodTypes = { listGpgKeysForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/gpg_keys"]["parameters"], + Endpoints["GET /users/{username}/gpg_keys"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/gpg_keys"]["response"]; + response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; }; listPublicEmailsForAuthenticated: { parameters: RequestParameters & @@ -4471,10 +4753,10 @@ export type RestEndpointMethodTypes = { listPublicKeysForUser: { parameters: RequestParameters & Omit< - Endpoints["GET /users/:username/keys"]["parameters"], + Endpoints["GET /users/{username}/keys"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /users/:username/keys"]["response"]; + response: Endpoints["GET /users/{username}/keys"]["response"]; }; listPublicSshKeysForAuthenticated: { parameters: RequestParameters & @@ -4495,18 +4777,18 @@ export type RestEndpointMethodTypes = { unblock: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/blocks/:username"]["parameters"], + Endpoints["DELETE /user/blocks/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/blocks/:username"]["response"]; + response: Endpoints["DELETE /user/blocks/{username}"]["response"]; }; unfollow: { parameters: RequestParameters & Omit< - Endpoints["DELETE /user/following/:username"]["parameters"], + Endpoints["DELETE /user/following/{username}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /user/following/:username"]["response"]; + response: Endpoints["DELETE /user/following/{username}"]["response"]; }; updateAuthenticated: { parameters: RequestParameters &