diff --git a/CHANGELOG.md b/CHANGELOG.md index 2353bca..84128a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # CHANGELOG.md +## 3.1.5 - 2023-10-25 + +> Only the generator and cli were published, the runtime is still at 3.1.3 + +### **Minor Changes** + +- Handle most of quoted property name issues [#47](https://github.com/Embraser01/typoas/issues/47) + +## 3.1.4 - 2023-08-21 + +> Only the generator and cli were published, the runtime is still at 3.1.3 + +> Version 3.1.2 and 3.1.3 are broken, please upgrade to 3.1.4 + +### **Minor Changes** + +- Fixes usage of the cli with npx (cf. [#45](https://github.com/Embraser01/typoas/issues/45), [#34](https://github.com/Embraser01/typoas/issues/34)) + ## 3.1.1 - 2023-07-04 > Version 3.1.0 is broken, please upgrade to 3.1.1 diff --git a/examples/src/github.ts b/examples/src/github.ts index dc6411c..93c331f 100644 --- a/examples/src/github.ts +++ b/examples/src/github.ts @@ -34,6 +34,278 @@ export type Root = { user_repositories_url: string; user_search_url: string; }; +/** + * The package's language or package management ecosystem. + */ +export enum SecurityAdvisoryEcosystems { + RUBYGEMS = 'rubygems', + NPM = 'npm', + PIP = 'pip', + MAVEN = 'maven', + NUGET = 'nuget', + COMPOSER = 'composer', + GO = 'go', + RUST = 'rust', + ERLANG = 'erlang', + ACTIONS = 'actions', + PUB = 'pub', + OTHER = 'other', + SWIFT = 'swift', +} +/** + * Simple User + * A GitHub user. + */ +export type SimpleUser = { + name?: string | null; + email?: string | null; + /** + * @example "octocat" + */ + login: string; + /** + * @example 1 + */ + id: number; + /** + * @example "MDQ6VXNlcjE=" + */ + node_id: string; + /** + * @example "https://github.com/images/error/octocat_happy.gif" + */ + avatar_url: string; + /** + * @example "41d064eb2195891e12d0413f63227ea7" + */ + gravatar_id: string | null; + /** + * @example "https://api.github.com/users/octocat" + */ + url: string; + /** + * @example "https://github.com/octocat" + */ + html_url: string; + /** + * @example "https://api.github.com/users/octocat/followers" + */ + followers_url: string; + /** + * @example "https://api.github.com/users/octocat/following{/other_user}" + */ + following_url: string; + /** + * @example "https://api.github.com/users/octocat/gists{/gist_id}" + */ + gists_url: string; + /** + * @example "https://api.github.com/users/octocat/starred{/owner}{/repo}" + */ + starred_url: string; + /** + * @example "https://api.github.com/users/octocat/subscriptions" + */ + subscriptions_url: string; + /** + * @example "https://api.github.com/users/octocat/orgs" + */ + organizations_url: string; + /** + * @example "https://api.github.com/users/octocat/repos" + */ + repos_url: string; + /** + * @example "https://api.github.com/users/octocat/events{/privacy}" + */ + events_url: string; + /** + * @example "https://api.github.com/users/octocat/received_events" + */ + received_events_url: string; + /** + * @example "User" + */ + type: string; + site_admin: boolean; + /** + * @example "\"2020-07-09T00:17:55Z\"" + */ + starred_at?: string; +}; +/** + * The type of credit the user is receiving. + */ +export enum SecurityAdvisoryCreditTypes { + ANALYST = 'analyst', + FINDER = 'finder', + REPORTER = 'reporter', + COORDINATOR = 'coordinator', + REMEDIATION_DEVELOPER = 'remediation_developer', + REMEDIATION_REVIEWER = 'remediation_reviewer', + REMEDIATION_VERIFIER = 'remediation_verifier', + TOOL = 'tool', + SPONSOR = 'sponsor', + OTHER = 'other', +} +/** + * A GitHub Security Advisory. + */ +export type GlobalAdvisory = { + /** + * The GitHub Security Advisory ID. + */ + ghsa_id: string; + /** + * The Common Vulnerabilities and Exposures (CVE) ID. + */ + cve_id: string | null; + /** + * The API URL for the advisory. + */ + url: string; + /** + * The URL for the advisory. + */ + html_url: string; + /** + * The API URL for the repository advisory. + */ + repository_advisory_url: string | null; + /** + * A short summary of the advisory. + */ + summary: string; + /** + * A detailed description of what the advisory entails. + */ + description: string | null; + /** + * The type of advisory. + */ + type: 'reviewed' | 'unreviewed' | 'malware'; + /** + * The severity of the advisory. + */ + severity: 'critical' | 'high' | 'medium' | 'low' | 'unknown'; + /** + * The URL of the advisory's source code. + */ + source_code_location: string | null; + identifiers: + | { + /** + * The type of identifier. + */ + type: 'CVE' | 'GHSA'; + /** + * The identifier value. + */ + value: string; + }[] + | null; + references: string[] | null; + /** + * The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: Date; + /** + * The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: Date; + /** + * The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + github_reviewed_at: Date | null; + /** + * The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + nvd_published_at: Date | null; + /** + * The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: Date | null; + /** + * The products and respective version ranges affected by the advisory. + */ + vulnerabilities: + | { + /** + * The name of the package affected by the vulnerability. + */ + package: { + ecosystem: SecurityAdvisoryEcosystems; + /** + * The unique package name within its ecosystem. + */ + name: string | null; + } | null; + /** + * The range of the package versions affected by the vulnerability. + */ + vulnerable_version_range: string | null; + /** + * The package version that resolve the vulnerability. + */ + first_patched_version: string | null; + /** + * The functions in the package that are affected by the vulnerability. + */ + vulnerable_functions: string[] | null; + }[] + | null; + cvss: { + /** + * The CVSS vector. + */ + vector_string: string | null; + /** + * The CVSS score. + */ + score: number | null; + } | null; + cwes: + | { + /** + * The Common Weakness Enumeration (CWE) identifier. + */ + cwe_id: string; + /** + * The name of the CWE. + */ + name: string; + }[] + | null; + /** + * The users who contributed to the advisory. + */ + credits: + | { + user: SimpleUser; + type: SecurityAdvisoryCreditTypes; + }[] + | null; +}; +/** + * Basic Error + * Basic Error + */ +export type BasicError = { + message?: string; + documentation_url?: string; + url?: string; + status?: string; +}; +/** + * Validation Error Simple + * Validation Error Simple + */ +export type ValidationErrorSimple = { + message: string; + documentation_url: string; + errors?: string[]; +}; /** * Simple User * A GitHub user. @@ -208,25 +480,6 @@ export type Integration = { */ pem?: string; }; -/** - * Basic Error - * Basic Error - */ -export type BasicError = { - message?: string; - documentation_url?: string; - url?: string; - status?: string; -}; -/** - * Validation Error Simple - * Validation Error Simple - */ -export type ValidationErrorSimple = { - message: string; - documentation_url: string; - errors?: string[]; -}; /** * The URL to which the payloads will be delivered. * @example "https://example.com/webhook" @@ -432,87 +685,6 @@ export type HookDelivery = { payload: string | null; }; }; -/** - * Simple User - * A GitHub user. - */ -export type SimpleUser = { - name?: string | null; - email?: string | null; - /** - * @example "octocat" - */ - login: string; - /** - * @example 1 - */ - id: number; - /** - * @example "MDQ6VXNlcjE=" - */ - node_id: string; - /** - * @example "https://github.com/images/error/octocat_happy.gif" - */ - avatar_url: string; - /** - * @example "41d064eb2195891e12d0413f63227ea7" - */ - gravatar_id: string | null; - /** - * @example "https://api.github.com/users/octocat" - */ - url: string; - /** - * @example "https://github.com/octocat" - */ - html_url: string; - /** - * @example "https://api.github.com/users/octocat/followers" - */ - followers_url: string; - /** - * @example "https://api.github.com/users/octocat/following{/other_user}" - */ - following_url: string; - /** - * @example "https://api.github.com/users/octocat/gists{/gist_id}" - */ - gists_url: string; - /** - * @example "https://api.github.com/users/octocat/starred{/owner}{/repo}" - */ - starred_url: string; - /** - * @example "https://api.github.com/users/octocat/subscriptions" - */ - subscriptions_url: string; - /** - * @example "https://api.github.com/users/octocat/orgs" - */ - organizations_url: string; - /** - * @example "https://api.github.com/users/octocat/repos" - */ - repos_url: string; - /** - * @example "https://api.github.com/users/octocat/events{/privacy}" - */ - events_url: string; - /** - * @example "https://api.github.com/users/octocat/received_events" - */ - received_events_url: string; - /** - * @example "User" - */ - type: string; - site_admin: boolean; - /** - * @example "\"2020-07-09T00:17:55Z\"" - */ - starred_at?: string; -}; /** * Enterprise * An enterprise on GitHub. @@ -582,7 +754,7 @@ export type IntegrationInstallationRequest = { }; /** * App Permissions - * The permissions granted to the user-to-server access token. + * The permissions granted to the user access token. * @example * { * "contents": "read", @@ -745,7 +917,7 @@ export type Installation = { */ repository_selection: 'all' | 'selected'; /** - * @example "https://api.github.com/installations/1/access_tokens" + * @example "https://api.github.com/app/installations/1/access_tokens" */ access_tokens_url: string; /** @@ -1098,6 +1270,7 @@ export type Repository = { * Whether downloads are enabled. * @example true * @defaultValue true + * @deprecated */ has_downloads: boolean; /** @@ -1444,6 +1617,409 @@ export type Authorization = { installation?: NullableScopedInstallation; expires_at: Date | null; }; +/** + * Simple Classroom Repository + * A GitHub repository view for Classroom + */ +export type SimpleClassroomRepository = { + /** + * A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * The full, globally unique name of the repository. + * @example "octocat/Hello-World" + */ + full_name: string; + /** + * The URL to view the repository on GitHub.com. + * @example "https://github.com/octocat/Hello-World" + */ + html_url: string; + /** + * The GraphQL identifier of the repository. + * @example "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + */ + node_id: string; + /** + * Whether the repository is private. + */ + private: boolean; + /** + * The default branch for the repository. + * @example "main" + */ + default_branch: string; +}; +/** + * Organization Simple for Classroom + * A GitHub organization. + */ +export type SimpleClassroomOrganization = { + /** + * @example 1 + */ + id: number; + /** + * @example "github" + */ + login: string; + /** + * @example "MDEyOk9yZ2FuaXphdGlvbjE=" + */ + node_id: string; + /** + * @example "https://github.com/github" + */ + html_url: string; + /** + * @example "Github - Code thigns happen here" + */ + name: string | null; + /** + * @example "https://github.com/images/error/octocat_happy.gif" + */ + avatar_url: string; +}; +/** + * Classroom + * A GitHub Classroom classroom + */ +export type Classroom = { + /** + * Unique identifier of the classroom. + * @example 42 + */ + id: number; + /** + * The name of the classroom. + * @example "Programming Elixir" + */ + name: string; + /** + * Whether classroom is archived. + */ + archived: boolean; + organization: SimpleClassroomOrganization; + /** + * The URL of the classroom on GitHub Classroom. + * @example "https://classroom.github.com/classrooms/1-programming-elixir" + */ + url: string; +}; +/** + * Classroom Assignment + * A GitHub Classroom assignment + */ +export type ClassroomAssignment = { + /** + * Unique identifier of the repository. + * @example 42 + */ + id: number; + /** + * Whether an accepted assignment creates a public repository. + * @example true + */ + public_repo: boolean; + /** + * Assignment title. + * @example "Intro to Binaries" + */ + title: string; + /** + * Whether it's a group assignment or individual assignment. + * @example "individual" + */ + type: 'individual' | 'group'; + /** + * The link that a student can use to accept the assignment. + * @example "https://classroom.github.com/a/Lx7jiUgx" + */ + invite_link: string; + /** + * Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. + * @example true + */ + invitations_enabled: boolean; + /** + * Sluggified name of the assignment. + * @example "intro-to-binaries" + */ + slug: string; + /** + * Whether students are admins on created repository when a student accepts the assignment. + * @example true + */ + students_are_repo_admins: boolean; + /** + * Whether feedback pull request will be created when a student accepts the assignment. + * @example true + */ + feedback_pull_requests_enabled: boolean; + /** + * The maximum allowable teams for the assignment. + */ + max_teams: number | null; + /** + * The maximum allowable members per team. + */ + max_members: number | null; + /** + * The selected editor for the assignment. + * @example "codespaces" + */ + editor: string; + /** + * The number of students that have accepted the assignment. + * @example 25 + */ + accepted: number; + /** + * The number of students that have submitted the assignment. + * @example 10 + */ + submitted: number; + /** + * The number of students that have passed the assignment. + * @example 10 + */ + passing: number; + /** + * The programming language used in the assignment. + * @example "elixir" + */ + language: string; + /** + * The time at which the assignment is due. + * @example "2011-01-26T19:06:43Z" + */ + deadline: Date | null; + starter_code_repository: SimpleClassroomRepository; + classroom: Classroom; +}; +/** + * Simple Classroom User + * A GitHub user simplified for Classroom. + */ +export type SimpleClassroomUser = { + /** + * @example 1 + */ + id: number; + /** + * @example "octocat" + */ + login: string; + /** + * @example "https://github.com/images/error/octocat_happy.gif" + */ + avatar_url: string; + /** + * @example "https://github.com/octocat" + */ + html_url: string; +}; +/** + * Simple Classroom + * A GitHub Classroom classroom + */ +export type SimpleClassroom = { + /** + * Unique identifier of the classroom. + * @example 42 + */ + id: number; + /** + * The name of the classroom. + * @example "Programming Elixir" + */ + name: string; + /** + * Returns whether classroom is archived or not. + */ + archived: boolean; + /** + * The url of the classroom on GitHub Classroom. + * @example "https://classroom.github.com/classrooms/1-programming-elixir" + */ + url: string; +}; +/** + * Simple Classroom Assignment + * A GitHub Classroom assignment + */ +export type SimpleClassroomAssignment = { + /** + * Unique identifier of the repository. + * @example 42 + */ + id: number; + /** + * Whether an accepted assignment creates a public repository. + * @example true + */ + public_repo: boolean; + /** + * Assignment title. + * @example "Intro to Binaries" + */ + title: string; + /** + * Whether it's a Group Assignment or Individual Assignment. + * @example "individual" + */ + type: 'individual' | 'group'; + /** + * The link that a student can use to accept the assignment. + * @example "https://classroom.github.com/a/Lx7jiUgx" + */ + invite_link: string; + /** + * Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. + * @example true + */ + invitations_enabled: boolean; + /** + * Sluggified name of the assignment. + * @example "intro-to-binaries" + */ + slug: string; + /** + * Whether students are admins on created repository on accepted assignment. + * @example true + */ + students_are_repo_admins: boolean; + /** + * Whether feedback pull request will be created on assignment acceptance. + * @example true + */ + feedback_pull_requests_enabled: boolean; + /** + * The maximum allowable teams for the assignment. + */ + max_teams?: number | null; + /** + * The maximum allowable members per team. + */ + max_members?: number | null; + /** + * The selected editor for the assignment. + * @example "codespaces" + */ + editor: string; + /** + * The number of students that have accepted the assignment. + * @example 25 + */ + accepted: number; + /** + * The number of students that have submitted the assignment. + * @example 10 + */ + submitted: number; + /** + * The number of students that have passed the assignment. + * @example 10 + */ + passing: number; + /** + * The programming language used in the assignment. + * @example "elixir" + */ + language: string; + /** + * The time at which the assignment is due. + * @example "2011-01-26T19:06:43Z" + */ + deadline: Date | null; + classroom: SimpleClassroom; +}; +/** + * Classroom Accepted Assignment + * A GitHub Classroom accepted assignment + */ +export type ClassroomAcceptedAssignment = { + /** + * Unique identifier of the repository. + * @example 42 + */ + id: number; + /** + * Whether an accepted assignment has been submitted. + * @example true + */ + submitted: boolean; + /** + * Whether a submission passed. + * @example true + */ + passing: boolean; + /** + * Count of student commits. + * @example 5 + */ + commit_count: number; + /** + * Most recent grade. + * @example "10/10" + */ + grade: string; + students: SimpleClassroomUser[]; + repository: SimpleClassroomRepository; + assignment: SimpleClassroomAssignment; +}; +/** + * Classroom Assignment Grade + * Grade for a student or groups GitHub Classroom assignment + */ +export type ClassroomAssignmentGrade = { + /** + * Name of the assignment + */ + assignment_name: string; + /** + * URL of the assignment + */ + assignment_url: string; + /** + * URL of the starter code for the assignment + */ + starter_code_url: string; + /** + * GitHub username of the student + */ + github_username: string; + /** + * Roster identifier of the student + */ + roster_identifier: string; + /** + * Name of the student's assignment repository + */ + student_repository_name: string; + /** + * URL of the student's assignment repository + */ + student_repository_url: string; + /** + * Timestamp of the student's assignment submission + */ + submission_timestamp: string; + /** + * Number of points awarded to the student + */ + points_awarded: number; + /** + * Number of points available for the assignment + */ + points_available: number; + /** + * If a group assignment, name of the group the student is in + */ + group_name?: string; +}; /** * Code Of Conduct * Code Of Conduct @@ -2885,6 +3461,13 @@ export type ApiOverview = { * ] */ hooks?: string[]; + /** + * @example + * [ + * "192.0.2.1" + * ] + */ + github_enterprise_importer?: string[]; /** * @example * [ @@ -2952,6 +3535,15 @@ export type SecurityAndAnalysis = { advanced_security?: { status?: 'enabled' | 'disabled'; }; + /** + * Enable or disable Dependabot security updates for the repository. + */ + dependabot_security_updates?: { + /** + * The enablement status of Dependabot security updates for the repository. + */ + status?: 'enabled' | 'disabled'; + }; secret_scanning?: { status?: 'enabled' | 'disabled'; }; @@ -3419,10 +4011,6 @@ export type OrganizationFull = { * @example "https://github.com/octocat" */ html_url: string; - /** - * @example "2008-01-14T04:33:35Z" - */ - created_at: Date; /** * @example "Organization" */ @@ -3497,7 +4085,6 @@ export type OrganizationFull = { members_can_create_private_pages?: boolean; members_can_fork_private_repositories?: boolean | null; web_commit_signoff_required?: boolean; - updated_at: Date; /** * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -3548,6 +4135,12 @@ export type OrganizationFull = { * @example "https://github.com/test-org/test-repo/blob/main/README.md" */ secret_scanning_push_protection_custom_link?: string | null; + /** + * @example "2008-01-14T04:33:35Z" + */ + created_at: Date; + updated_at: Date; + archived_at: Date | null; }; export type ActionsCacheUsageOrgEnterprise = { /** @@ -3659,39 +4252,6 @@ export type ActionsSetDefaultWorkflowPermissions = { default_workflow_permissions?: ActionsDefaultWorkflowPermissions; can_approve_pull_request_reviews?: ActionsCanApprovePullRequestReviews; }; -export type RequiredWorkflow = { - /** - * Unique identifier for a required workflow - */ - id: number; - /** - * Name present in the workflow file - */ - name: string; - /** - * Path of the workflow file - */ - path: string; - /** - * Scope of the required workflow - */ - scope: 'all' | 'selected'; - /** - * Ref at which the workflow file will be selected - */ - ref: string; - /** - * State of the required workflow - */ - state: 'active' | 'deleted'; - /** - * @example "https://api.github.com/organizations/org/actions/required_workflows/1/repositories" - */ - selected_repositories_url?: string; - created_at: Date; - updated_at: Date; - repository: MinimalRepository; -}; /** * Self hosted runner label * A label for a self hosted runner @@ -3892,7 +4452,7 @@ export type CodeScanningAnalysisToolGuid = string | null; /** * State of a code scanning alert. */ -export enum CodeScanningAlertState { +export enum CodeScanningAlertStateQuery { OPEN = 'open', CLOSED = 'closed', DISMISSED = 'dismissed', @@ -3914,6 +4474,14 @@ export enum CodeScanningAlertSeverity { * The REST API URL for fetching the list of instances for an alert. */ export type AlertInstancesUrl = string; +/** + * State of a code scanning alert. + */ +export enum CodeScanningAlertState { + OPEN = 'open', + DISMISSED = 'dismissed', + FIXED = 'fixed', +} /** * **Required when the state is dismissed.** The reason for dismissing or closing the alert. */ @@ -4052,7 +4620,7 @@ export type NullableCodespaceMachine = { name: string; /** * The display name of the machine includes cores, memory, and storage. - * @example "4 cores, 8 GB RAM, 64 GB storage" + * @example "4 cores, 16 GB RAM, 64 GB storage" */ display_name: string; /** @@ -4067,7 +4635,7 @@ export type NullableCodespaceMachine = { storage_in_bytes: number; /** * How much memory is available to the codespace. - * @example 8589934592 + * @example 17179869184 */ memory_in_bytes: number; /** @@ -4312,6 +4880,265 @@ export type CodespacesPublicKey = { */ created_at?: string; }; +/** + * Copilot for Business Seat Breakdown + * The breakdown of Copilot for Business seats for the organization. + */ +export type CopilotSeatBreakdown = { + /** + * The total number of seats being billed for the organization as of the current billing cycle. + */ + total?: number; + /** + * Seats added during the current billing cycle. + */ + added_this_cycle?: number; + /** + * The number of seats that are pending cancellation at the end of the current billing cycle. + */ + pending_cancellation?: number; + /** + * The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. + */ + pending_invitation?: number; + /** + * The number of seats that have used Copilot during the current billing cycle. + */ + active_this_cycle?: number; + /** + * The number of seats that have not used Copilot during the current billing cycle. + */ + inactive_this_cycle?: number; +}; +/** + * Copilot for Business Organization Details + * Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription. + */ +export type CopilotOrganizationDetails = { + seat_breakdown: CopilotSeatBreakdown; + /** + * The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + */ + public_code_suggestions: 'allow' | 'block' | 'unconfigured' | 'unknown'; + /** + * The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + */ + copilot_chat?: 'enabled' | 'disabled' | 'unconfigured'; + /** + * The mode of assigning new seats. + */ + seat_management_setting: + | 'assign_all' + | 'assign_selected' + | 'disabled' + | 'unconfigured'; +} & { + [key: string]: any; +}; +/** + * Team Simple + * Groups of organization members that gives permissions on specified repositories. + */ +export type NullableTeamSimple = { + /** + * Unique identifier of the team + * @example 1 + */ + id: number; + /** + * @example "MDQ6VGVhbTE=" + */ + node_id: string; + /** + * URL for the team + * @example "https://api.github.com/organizations/1/team/1" + */ + url: string; + /** + * @example "https://api.github.com/organizations/1/team/1/members{/member}" + */ + members_url: string; + /** + * Name of the team + * @example "Justice League" + */ + name: string; + /** + * Description of the team + * @example "A great team." + */ + description: string | null; + /** + * Permission that the team will have for its repositories + * @example "admin" + */ + permission: string; + /** + * The level of privacy this team should have + * @example "closed" + */ + privacy?: string; + /** + * The notification setting the team has set + * @example "notifications_enabled" + */ + notification_setting?: string; + /** + * @example "https://github.com/orgs/rails/teams/core" + */ + html_url: string; + /** + * @example "https://api.github.com/organizations/1/team/1/repos" + */ + repositories_url: string; + /** + * @example "justice-league" + */ + slug: string; + /** + * Distinguished Name (DN) that team maps to within LDAP environment + * @example "uid=example,ou=users,dc=github,dc=com" + */ + ldap_dn?: string; +} | null; +/** + * Team + * Groups of organization members that gives permissions on specified repositories. + */ +export type Team = { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + url: string; + /** + * @example "https://github.com/orgs/rails/teams/core" + */ + html_url: string; + members_url: string; + repositories_url: string; + parent: NullableTeamSimple; +}; +/** + * Organization + * GitHub account for managing multiple users, teams, and repositories + */ +export type Organization = { + /** + * Unique login name of the organization + * @example "new-org" + */ + login: string; + /** + * URL for the organization + * @example "https://api.github.com/orgs/github" + */ + url: string; + id: number; + node_id: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + /** + * Display blog url for the organization + * @example "blog.example-org.com" + */ + blog?: string; + html_url: string; + /** + * Display name for the organization + * @example "New Org" + */ + name?: string; + /** + * Display company name for the organization + * @example "Acme corporation" + */ + company?: string; + /** + * Display location for the organization + * @example "Berlin, Germany" + */ + location?: string; + /** + * Display email for the organization + * @example "org@example.com" + */ + email?: string; + /** + * Specifies if organization projects are enabled for this org + */ + has_organization_projects: boolean; + /** + * Specifies if repository projects are enabled for repositories that belong to this org + */ + has_repository_projects: boolean; + is_verified?: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + type: string; + created_at: Date; + updated_at: Date; + plan?: { + name?: string; + space?: number; + private_repos?: number; + filled_seats?: number; + seats?: number; + }; +}; +/** + * Copilot for Business Seat Detail + * Information about a Copilot for Business seat assignment for a user, team, or organization. + */ +export type CopilotSeatDetails = { + /** + * The assignee that has been granted access to GitHub Copilot. + */ + assignee: SimpleUser | Team | Organization; + /** + * The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. + */ + assigning_team?: Team | null; + /** + * The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: Date | null; + /** + * Last editor that was used by the user for a GitHub Copilot completion. + */ + last_activity_editor?: string | null; + /** + * Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: Date; + /** + * Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: Date; +}; /** * Dependabot Secret for an Organization * Secrets for GitHub Dependabot for an organization. @@ -4774,101 +5601,6 @@ export type InteractionLimit = { limit: InteractionGroup; expiry?: InteractionExpiry; }; -/** - * Team Simple - * Groups of organization members that gives permissions on specified repositories. - */ -export type NullableTeamSimple = { - /** - * Unique identifier of the team - * @example 1 - */ - id: number; - /** - * @example "MDQ6VGVhbTE=" - */ - node_id: string; - /** - * URL for the team - * @example "https://api.github.com/organizations/1/team/1" - */ - url: string; - /** - * @example "https://api.github.com/organizations/1/team/1/members{/member}" - */ - members_url: string; - /** - * Name of the team - * @example "Justice League" - */ - name: string; - /** - * Description of the team - * @example "A great team." - */ - description: string | null; - /** - * Permission that the team will have for its repositories - * @example "admin" - */ - permission: string; - /** - * The level of privacy this team should have - * @example "closed" - */ - privacy?: string; - /** - * The notification setting the team has set - * @example "notifications_enabled" - */ - notification_setting?: string; - /** - * @example "https://github.com/orgs/rails/teams/core" - */ - html_url: string; - /** - * @example "https://api.github.com/organizations/1/team/1/repos" - */ - repositories_url: string; - /** - * @example "justice-league" - */ - slug: string; - /** - * Distinguished Name (DN) that team maps to within LDAP environment - * @example "uid=example,ou=users,dc=github,dc=com" - */ - ldap_dn?: string; -} | null; -/** - * Team - * Groups of organization members that gives permissions on specified repositories. - */ -export type Team = { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - url: string; - /** - * @example "https://github.com/orgs/rails/teams/core" - */ - html_url: string; - members_url: string; - repositories_url: string; - parent: NullableTeamSimple; -}; /** * Org Membership * Org Membership @@ -5189,6 +5921,73 @@ export type Project = { */ private?: boolean; }; +/** + * Organization Custom Property + * Custom property defined on an organization + */ +export type OrgCustomProperty = { + /** + * The name of the property + */ + property_name: string; + /** + * The type of the value for the property + * @example "single_select" + */ + value_type: 'string' | 'single_select'; + /** + * Whether the property is required. + */ + required?: boolean; + /** + * Default value of the property + */ + default_value?: string | null; + /** + * Short description of the property + */ + description?: string | null; + /** + * Ordered list of allowed values of the property + */ + allowed_values?: string[] | null; +}; +/** + * Custom Property Value + * Custom property name and associated value + */ +export type CustomPropertyValue = { + /** + * The name of the property + */ + property_name: string; + /** + * The value assigned to the property + */ + value: string | null; +}; +/** + * Organization Repository Custom Property Values + * List of custom property values for a repository + */ +export type OrgRepoCustomPropertyValues = { + /** + * @example 1296269 + */ + repository_id: number; + /** + * @example "Hello-World" + */ + repository_name: string; + /** + * @example "octocat/Hello-World" + */ + repository_full_name: string; + /** + * List of custom property names and associated values + */ + properties: CustomPropertyValue[]; +}; /** * The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). */ @@ -5203,13 +6002,17 @@ export enum RepositoryRuleEnforcement { */ export type RepositoryRulesetBypassActor = { /** - * The ID of the actor that can bypass a ruleset + * The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ - actor_id?: number; + actor_id: number; /** * The type of actor that can bypass a ruleset */ - actor_type?: 'Team' | 'Integration'; + actor_type: 'RepositoryRole' | 'Team' | 'Integration' | 'OrganizationAdmin'; + /** + * When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + */ + bypass_mode: 'always' | 'pull_request'; }; /** * Repository ruleset conditions for ref names @@ -5232,7 +6035,7 @@ export type RepositoryRulesetConditions = { * Parameters for a repository name condition */ export type RepositoryRulesetConditionsRepositoryNameTarget = { - repository_name?: { + repository_name: { /** * Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ @@ -5247,12 +6050,27 @@ export type RepositoryRulesetConditionsRepositoryNameTarget = { protected?: boolean; }; }; +/** + * Repository ruleset conditions for repository IDs + * Parameters for a repository ID condition + */ +export type RepositoryRulesetConditionsRepositoryIdTarget = { + repository_id: { + /** + * The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. + */ + repository_ids?: number[]; + }; +}; /** * Organization ruleset conditions - * Conditions for a organization ruleset + * Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. */ -export type OrgRulesetConditions = RepositoryRulesetConditions & - RepositoryRulesetConditionsRepositoryNameTarget; +export type OrgRulesetConditions = + | (RepositoryRulesetConditions & + RepositoryRulesetConditionsRepositoryNameTarget) + | (RepositoryRulesetConditions & + RepositoryRulesetConditionsRepositoryIdTarget); /** * creation * Only allow users with bypass permission to create matching refs. @@ -5282,14 +6100,14 @@ export type RepositoryRuleDeletion = { }; /** * required_linear_history - * Prevent merge commits from being pushed to matching branches. + * Prevent merge commits from being pushed to matching refs. */ export type RepositoryRuleRequiredLinearHistory = { type: 'required_linear_history'; }; /** * required_deployments - * Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. + * Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. */ export type RepositoryRuleRequiredDeployments = { type: 'required_deployments'; @@ -5302,7 +6120,7 @@ export type RepositoryRuleRequiredDeployments = { }; /** * required_signatures - * Commits pushed to matching branches must have verified signatures. + * Commits pushed to matching refs must have verified signatures. */ export type RepositoryRuleRequiredSignatures = { type: 'required_signatures'; @@ -5352,7 +6170,7 @@ export type RepositoryRuleParamsStatusCheckConfiguration = { }; /** * required_status_checks - * Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. + * Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. */ export type RepositoryRuleRequiredStatusChecks = { type: 'required_status_checks'; @@ -5369,7 +6187,7 @@ export type RepositoryRuleRequiredStatusChecks = { }; /** * non_fast_forward - * Prevent users with push access from force pushing to branches. + * Prevent users with push access from force pushing to refs. */ export type RepositoryRuleNonFastForward = { type: 'non_fast_forward'; @@ -5499,6 +6317,41 @@ export type RepositoryRuleTagNamePattern = { pattern: string; }; }; +/** + * WorkflowFileReference + * A workflow that must run for this rule to pass + */ +export type RepositoryRuleParamsWorkflowFileReference = { + /** + * The path to the workflow file + */ + path: string; + /** + * The ref (branch or tag) of the workflow file to use + */ + ref?: string; + /** + * The ID of the repository where the workflow is defined + */ + repository_id: number; + /** + * The commit SHA of the workflow file to use + */ + sha?: string; +}; +/** + * workflows + * Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ +export type RepositoryRuleWorkflows = { + type: 'workflows'; + parameters?: { + /** + * Workflows that must pass for this rule to pass. + */ + workflows: RepositoryRuleParamsWorkflowFileReference[]; + }; +}; /** * Repository Rule * A repository rule. @@ -5517,7 +6370,8 @@ export type RepositoryRule = | RepositoryRuleCommitAuthorEmailPattern | RepositoryRuleCommitterEmailPattern | RepositoryRuleBranchNamePattern - | RepositoryRuleTagNamePattern; + | RepositoryRuleTagNamePattern + | RepositoryRuleWorkflows; /** * Repository ruleset * A set of rules to apply when specified conditions are met. @@ -5544,14 +6398,15 @@ export type RepositoryRuleset = { */ source: string; enforcement: RepositoryRuleEnforcement; - /** - * The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing. - */ - bypass_mode?: 'none' | 'repository' | 'organization'; /** * The actors that can bypass the rules in this ruleset */ bypass_actors?: RepositoryRulesetBypassActor[]; + /** + * The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + */ + current_user_can_bypass?: 'always' | 'pull_requests_only' | 'never'; node_id?: string; _links?: { self?: { @@ -5572,6 +6427,309 @@ export type RepositoryRuleset = { created_at?: Date; updated_at?: Date; }; +/** + * Rule Suites + * Response + */ +export type RuleSuites = { + /** + * The unique identifier of the rule insight. + */ + id?: number; + /** + * The number that identifies the user. + */ + actor_id?: number; + /** + * The handle for the GitHub user account. + */ + actor_name?: string; + /** + * The first commit sha before the push evaluation. + */ + before_sha?: string; + /** + * The last commit sha in the push evaluation. + */ + after_sha?: string; + /** + * The ref name that the evaluation ran on. + */ + ref?: string; + /** + * The ID of the repository associated with the rule evaluation. + */ + repository_id?: number; + /** + * The name of the repository without the `.git` extension. + */ + repository_name?: string; + /** + * @example "2011-01-26T19:06:43Z" + */ + pushed_at?: Date; + /** + * The result of the rule evaluations for rules with the `active` enforcement status. + */ + result?: 'pass' | 'fail' | 'bypass'; + /** + * The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + */ + evaluation_result?: 'pass' | 'fail'; +}[]; +/** + * Rule Suite + * Response + */ +export type RuleSuite = { + /** + * The unique identifier of the rule insight. + */ + id?: number; + /** + * The number that identifies the user. + */ + actor_id?: number; + /** + * The handle for the GitHub user account. + */ + actor_name?: string; + /** + * The first commit sha before the push evaluation. + */ + before_sha?: string; + /** + * The last commit sha in the push evaluation. + */ + after_sha?: string; + /** + * The ref name that the evaluation ran on. + */ + ref?: string; + /** + * The ID of the repository associated with the rule evaluation. + */ + repository_id?: number; + /** + * The name of the repository without the `.git` extension. + */ + repository_name?: string; + /** + * @example "2011-01-26T19:06:43Z" + */ + pushed_at?: Date; + /** + * The result of the rule evaluations for rules with the `active` enforcement status. + */ + result?: 'pass' | 'fail' | 'bypass'; + /** + * The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + */ + evaluation_result?: 'pass' | 'fail'; + /** + * Details on the evaluated rules. + */ + rule_evaluations?: { + rule_source?: { + /** + * The type of rule source. + */ + type?: string; + /** + * The ID of the rule source. + */ + id?: number | null; + /** + * The name of the rule source. + */ + name?: string | null; + }; + /** + * The enforcement level of this rule source. + */ + enforcement?: 'active' | 'evaluate' | 'deleted ruleset'; + /** + * The result of the evaluation of the individual rule. + */ + result?: 'pass' | 'fail'; + /** + * The type of rule. + */ + rule_type?: string; + /** + * Any associated details with the rule evaluation. + */ + details?: string; + }[]; +}; +/** + * A product affected by the vulnerability detailed in a repository security advisory. + */ +export type RepositoryAdvisoryVulnerability = { + /** + * The name of the package affected by the vulnerability. + */ + package: { + ecosystem: SecurityAdvisoryEcosystems; + /** + * The unique package name within its ecosystem. + */ + name: string | null; + } | null; + /** + * The range of the package versions affected by the vulnerability. + */ + vulnerable_version_range: string | null; + /** + * The package version(s) that resolve the vulnerability. + */ + patched_versions: string | null; + /** + * The functions in the package that are affected. + */ + vulnerable_functions: string[] | null; +}; +/** + * A credit given to a user for a repository security advisory. + */ +export type RepositoryAdvisoryCredit = { + user: SimpleUser; + type: SecurityAdvisoryCreditTypes; + /** + * The state of the user's acceptance of the credit. + */ + state: 'accepted' | 'declined' | 'pending'; +}; +/** + * A repository security advisory. + */ +export type RepositoryAdvisory = { + /** + * The GitHub Security Advisory ID. + */ + ghsa_id: string; + /** + * The Common Vulnerabilities and Exposures (CVE) ID. + */ + cve_id: string | null; + /** + * The API URL for the advisory. + */ + url: string; + /** + * The URL for the advisory. + */ + html_url: string; + /** + * A short summary of the advisory. + */ + summary: string; + /** + * A detailed description of what the advisory entails. + */ + description: string | null; + /** + * The severity of the advisory. + */ + severity: ('critical' | 'high' | 'medium' | 'low') | null; + /** + * The author of the advisory. + */ + author: SimpleUser | null; + /** + * The publisher of the advisory. + */ + publisher: SimpleUser | null; + identifiers: { + /** + * The type of identifier. + */ + type: 'CVE' | 'GHSA'; + /** + * The identifier value. + */ + value: string; + }[]; + /** + * The state of the advisory. + */ + state: 'published' | 'closed' | 'withdrawn' | 'draft' | 'triage'; + /** + * The date and time of when the advisory was created, in ISO 8601 format. + */ + created_at: Date | null; + /** + * The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: Date | null; + /** + * The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: Date | null; + /** + * The date and time of when the advisory was closed, in ISO 8601 format. + */ + closed_at: Date | null; + /** + * The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: Date | null; + submission: { + /** + * Whether a private vulnerability report was accepted by the repository's administrators. + */ + accepted: boolean; + } | null; + vulnerabilities: RepositoryAdvisoryVulnerability[] | null; + cvss: { + /** + * The CVSS vector. + */ + vector_string: string | null; + /** + * The CVSS score. + */ + score: number | null; + } | null; + cwes: + | { + /** + * The Common Weakness Enumeration (CWE) identifier. + */ + cwe_id: string; + /** + * The name of the CWE. + */ + name: string; + }[] + | null; + /** + * A list of only the CWE IDs. + */ + cwe_ids: string[] | null; + credits: + | { + /** + * The username of the user credited. + */ + login?: string; + type?: SecurityAdvisoryCreditTypes; + }[] + | null; + credits_detailed: RepositoryAdvisoryCredit[] | null; + /** + * A list of users that collaborate on the advisory. + */ + collaborating_users: SimpleUser[] | null; + /** + * A list of teams that collaborate on the advisory. + */ + collaborating_teams: Team[] | null; + /** + * A temporary private fork of the advisory's repository for collaborating on a fix. + */ + private_fork: SimpleRepository | null; +}; /** * Team Simple * Groups of organization members that gives permissions on specified repositories. @@ -5927,6 +7085,7 @@ export type TeamOrganization = { members_can_fork_private_repositories?: boolean | null; web_commit_signoff_required?: boolean; updated_at: Date; + archived_at: Date | null; }; /** * Full Team @@ -6488,6 +7647,7 @@ export type NullableRepository = { * Whether downloads are enabled. * @example true * @defaultValue true + * @deprecated */ has_downloads: boolean; /** @@ -7217,70 +8377,6 @@ export type RateLimitOverview = { }; rate: RateLimit; }; -/** - * Required workflow - * A GitHub Actions required workflow - */ -export type RepoRequiredWorkflow = { - /** - * @example 5 - */ - id: number; - /** - * @example "MDg6V29ya2Zsb3cxMg==" - */ - node_id: string; - /** - * @example "Required CI" - */ - name: string; - /** - * @example ".github/workflows/required_ci.yaml" - */ - path: string; - /** - * @example "active" - */ - state: 'active' | 'deleted'; - source_repository: MinimalRepository; - /** - * @example "2019-12-06T14:20:20.000Z" - */ - created_at: Date; - /** - * @example "2019-12-06T14:20:20.000Z" - */ - updated_at: Date; - /** - * @example "https://api.github.com/repos/sample-org/sample-repo/actions/required_workflows/5" - */ - url: string; - /** - * @example "https://github.com/sample-org/source-repo/blob/main/.github/workflows/required_ci.yaml" - */ - html_url: string; - /** - * @example "https://github.com/sample-org/sample-repo/workflows/required/sample-org/source-repo/.github/workflows/required_ci.yaml/badge.svg" - */ - badge_url: string; -}; -/** - * Workflow Usage - * Workflow Usage - */ -export type WorkflowUsage = { - billable: { - UBUNTU?: { - total_ms?: number; - }; - MACOS?: { - total_ms?: number; - }; - WINDOWS?: { - total_ms?: number; - }; - }; -}; /** * Code Of Conduct Simple * Code of Conduct Simple @@ -7560,7 +8656,7 @@ export type FullRepository = { /** * @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** * @example true */ @@ -7825,7 +8921,7 @@ export type Job = { * The phase of the lifecycle that the job is currently in. * @example "queued" */ - status: 'queued' | 'in_progress' | 'completed'; + status: 'queued' | 'in_progress' | 'completed' | 'waiting'; /** * The outcome of the job. * @example "success" @@ -8180,6 +9276,9 @@ export type WorkflowRun = { * @example "https://github.com/github/hello-world/suites/4" */ html_url: string; + /** + * Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ pull_requests: PullRequestMinimal[] | null; created_at: Date; updated_at: Date; @@ -8547,6 +9646,69 @@ export type Workflow = { */ deleted_at?: Date; }; +/** + * Workflow Usage + * Workflow Usage + */ +export type WorkflowUsage = { + billable: { + UBUNTU?: { + total_ms?: number; + }; + MACOS?: { + total_ms?: number; + }; + WINDOWS?: { + total_ms?: number; + }; + }; +}; +/** + * Activity + * Activity + */ +export type Activity = { + /** + * @example 1296269 + */ + id: number; + /** + * @example "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + */ + node_id: string; + /** + * The SHA of the commit before the activity. + * @example "6dcb09b5b57875f334f61aebed695e2e4193db5e" + */ + before: string; + /** + * The SHA of the commit after the activity. + * @example "827efc6d56897b048c772eb4087f854f46256132" + */ + after: string; + /** + * The full Git reference, formatted as `refs/heads/`. + * @example "refs/heads/main" + */ + ref: string; + /** + * The time when the activity occurred. + * @example "2011-01-26T19:06:43Z" + */ + timestamp: Date; + /** + * The type of the activity that was performed. + * @example "force_push" + */ + activity_type: + | 'push' + | 'force_push' + | 'branch_deletion' + | 'branch_creation' + | 'pr_merge' + | 'merge_queue_merge'; + actor: NullableSimpleUser; +}; /** * Autolink reference * An autolink reference. @@ -8572,6 +9734,21 @@ export type Autolink = { */ is_alphanumeric: boolean; }; +/** + * Check Automated Security Fixes + * Check Automated Security Fixes + */ +export type CheckAutomatedSecurityFixes = { + /** + * Whether automated security fixes are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * Whether automated security fixes are paused for the repository. + */ + paused: boolean; +}; /** * Protected Branch Required Status Check * Protected Branch Required Status Check @@ -9286,6 +10463,9 @@ export type CheckRun = { id: number; } | null; app: NullableIntegration; + /** + * Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. + */ pull_requests: PullRequestMinimal[]; deployment?: DeploymentSimple; }; @@ -9635,6 +10815,10 @@ export type CodeScanningCodeqlDatabase = { * The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ url: string; + /** + * The commit SHA of the repository at the time the CodeQL database was created. + */ + commit_oid?: string | null; }; /** * Configuration for code scanning default setup. @@ -9645,7 +10829,7 @@ export type CodeScanningDefaultSetup = { */ state?: 'configured' | 'not-configured'; /** - * Languages to be analysed. + * Languages to be analyzed. */ languages?: ( | 'c-cpp' @@ -9657,6 +10841,7 @@ export type CodeScanningDefaultSetup = { | 'python' | 'ruby' | 'typescript' + | 'swift' )[]; /** * CodeQL query suite to be used. @@ -9667,6 +10852,10 @@ export type CodeScanningDefaultSetup = { * @example "2023-12-06T14:20:20.000Z" */ updated_at?: Date | null; + /** + * The frequency of the periodic analysis. + */ + schedule?: 'weekly' | null; }; /** * Configuration for code scanning default setup. @@ -9681,7 +10870,7 @@ export type CodeScanningDefaultSetupUpdate = { */ query_suite?: 'default' | 'extended'; /** - * CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, and `ruby`. + * CodeQL languages to be analyzed. */ languages?: ( | 'c-cpp' @@ -9691,6 +10880,7 @@ export type CodeScanningDefaultSetupUpdate = { | 'javascript-typescript' | 'python' | 'ruby' + | 'swift' )[]; }; /** @@ -9787,7 +10977,7 @@ export type CodespaceMachine = { name: string; /** * The display name of the machine includes cores, memory, and storage. - * @example "4 cores, 8 GB RAM, 64 GB storage" + * @example "4 cores, 16 GB RAM, 64 GB storage" */ display_name: string; /** @@ -9802,7 +10992,7 @@ export type CodespaceMachine = { storage_in_bytes: number; /** * How much memory is available to the codespace. - * @example 8589934592 + * @example 17179869184 */ memory_in_bytes: number; /** @@ -9816,6 +11006,17 @@ export type CodespaceMachine = { */ prebuild_availability: ('none' | 'ready' | 'in_progress') | null; }; +/** + * Codespaces Permissions Check + * Permission check result for a given devcontainer config. + */ +export type CodespacesPermissionsCheckForDevcontainer = { + /** + * Whether the user has accepted the permissions defined by the devcontainer config + * @example true + */ + accepted: boolean; +}; /** * Codespaces Secret * Set repository secrets for GitHub Codespaces. @@ -11128,6 +12329,10 @@ export type Environment = { * @example "MDQ6R2F0ZTM3NTU=" */ node_id: string; + /** + * Whether deployments to this environment can be approved by the user who created the deployment. + */ + prevent_self_review?: boolean; /** * @example "required_reviewers" */ @@ -11157,13 +12362,17 @@ export type Environment = { )[]; deployment_branch_policy?: DeploymentBranchPolicySettings; }; +/** + * Whether or not a user who created the job is prevented from approving their own job. + */ +export type PreventSelfReview = boolean; /** * Deployment branch policy - * Details of a deployment branch policy. + * Details of a deployment branch or tag policy. */ export type DeploymentBranchPolicy = { /** - * The unique identifier of the branch policy. + * The unique identifier of the branch or tag policy. * @example 361471 */ id?: number; @@ -11172,10 +12381,33 @@ export type DeploymentBranchPolicy = { */ node_id?: string; /** - * The name pattern that branches must match in order to deploy to the environment. + * The name pattern that branches or tags must match in order to deploy to the environment. * @example "release/*" */ name?: string; + /** + * Whether this rule targets a branch or tag. + * @example "branch" + */ + type?: 'branch' | 'tag'; +}; +/** + * Deployment branch and tag policy name pattern + */ +export type DeploymentBranchPolicyNamePatternWithType = { + /** + * The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example "release/*" + */ + name: string; + /** + * Whether this rule targets a branch or tag + * @example "branch" + */ + type?: 'branch' | 'tag'; }; /** * Deployment branch policy name pattern @@ -13672,6 +14904,31 @@ export type ReleaseNotesContent = { */ body: string; }; +/** + * repository ruleset data for rule + * User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + */ +export type RepositoryRuleRulesetInfo = any; +/** + * Repository Rule + * A repository rule with ruleset details. + */ +export type RepositoryRuleDetailed = + | (RepositoryRuleCreation & RepositoryRuleRulesetInfo) + | (RepositoryRuleUpdate & RepositoryRuleRulesetInfo) + | (RepositoryRuleDeletion & RepositoryRuleRulesetInfo) + | (RepositoryRuleRequiredLinearHistory & RepositoryRuleRulesetInfo) + | (RepositoryRuleRequiredDeployments & RepositoryRuleRulesetInfo) + | (RepositoryRuleRequiredSignatures & RepositoryRuleRulesetInfo) + | (RepositoryRulePullRequest & RepositoryRuleRulesetInfo) + | (RepositoryRuleRequiredStatusChecks & RepositoryRuleRulesetInfo) + | (RepositoryRuleNonFastForward & RepositoryRuleRulesetInfo) + | (RepositoryRuleCommitMessagePattern & RepositoryRuleRulesetInfo) + | (RepositoryRuleCommitAuthorEmailPattern & RepositoryRuleRulesetInfo) + | (RepositoryRuleCommitterEmailPattern & RepositoryRuleRulesetInfo) + | (RepositoryRuleBranchNamePattern & RepositoryRuleRulesetInfo) + | (RepositoryRuleTagNamePattern & RepositoryRuleRulesetInfo) + | (RepositoryRuleWorkflows & RepositoryRuleRulesetInfo); export type SecretScanningAlert = { number?: AlertNumber; created_at?: AlertCreatedAt; @@ -13806,194 +15063,6 @@ export type SecretScanningLocation = { | SecretScanningLocationIssueBody | SecretScanningLocationIssueComment; }; -/** - * The package's language or package management ecosystem. - */ -export enum SecurityAdvisoryEcosystems { - RUBYGEMS = 'rubygems', - NPM = 'npm', - PIP = 'pip', - MAVEN = 'maven', - NUGET = 'nuget', - COMPOSER = 'composer', - GO = 'go', - RUST = 'rust', - ERLANG = 'erlang', - ACTIONS = 'actions', - PUB = 'pub', - OTHER = 'other', -} -/** - * A product affected by the vulnerability detailed in a repository security advisory. - */ -export type RepositoryAdvisoryVulnerability = { - /** - * The name of the package affected by the vulnerability. - */ - package: { - ecosystem: SecurityAdvisoryEcosystems; - /** - * The unique package name within its ecosystem. - */ - name: string | null; - } | null; - /** - * The range of the package versions affected by the vulnerability. - */ - vulnerable_version_range: string | null; - /** - * The package version(s) that resolve the vulnerability. - */ - patched_versions: string | null; - /** - * The functions in the package that are affected. - */ - vulnerable_functions: string[] | null; -}; -/** - * The type of credit the user is receiving. - */ -export enum SecurityAdvisoryCreditTypes { - ANALYST = 'analyst', - FINDER = 'finder', - REPORTER = 'reporter', - COORDINATOR = 'coordinator', - REMEDIATION_DEVELOPER = 'remediation_developer', - REMEDIATION_REVIEWER = 'remediation_reviewer', - REMEDIATION_VERIFIER = 'remediation_verifier', - TOOL = 'tool', - SPONSOR = 'sponsor', - OTHER = 'other', -} -/** - * A credit given to a user for a repository security advisory. - */ -export type RepositoryAdvisoryCredit = { - user: SimpleUser; - type: SecurityAdvisoryCreditTypes; - /** - * The state of the user's acceptance of the credit. - */ - state: 'accepted' | 'declined' | 'pending'; -}; -/** - * A repository security advisory. - */ -export type RepositoryAdvisory = { - /** - * The GitHub Security Advisory ID. - */ - ghsa_id: string; - /** - * The Common Vulnerabilities and Exposures (CVE) ID. - */ - cve_id: string | null; - /** - * The API URL for the advisory. - */ - url: string; - /** - * The URL for the advisory. - */ - html_url: string; - /** - * A short summary of the advisory. - */ - summary: string; - /** - * A detailed description of what the advisory entails. - */ - description: string | null; - /** - * The severity of the advisory. - */ - severity: ('critical' | 'high' | 'medium' | 'low') | null; - /** - * The author of the advisory. - */ - author: SimpleUser | null; - /** - * The publisher of the advisory. - */ - publisher: SimpleUser | null; - identifiers: { - /** - * The type of identifier. - */ - type: 'CVE' | 'GHSA'; - /** - * The identifier value. - */ - value: string; - }[]; - /** - * The state of the advisory. - */ - state: 'published' | 'closed' | 'withdrawn' | 'draft' | 'triage'; - /** - * The date and time of when the advisory was created, in ISO 8601 format. - */ - created_at: Date | null; - /** - * The date and time of when the advisory was last updated, in ISO 8601 format. - */ - updated_at: Date | null; - /** - * The date and time of when the advisory was published, in ISO 8601 format. - */ - published_at: Date | null; - /** - * The date and time of when the advisory was closed, in ISO 8601 format. - */ - closed_at: Date | null; - /** - * The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - withdrawn_at: Date | null; - submission: { - /** - * Whether a private vulnerability report was accepted by the repository's administrators. - */ - accepted: boolean; - } | null; - vulnerabilities: RepositoryAdvisoryVulnerability[] | null; - cvss: { - /** - * The CVSS vector. - */ - vector_string: string | null; - /** - * The CVSS score. - */ - score: number | null; - } | null; - cwes: - | { - /** - * The Common Weakness Enumeration (CWE) identifier. - */ - cwe_id: string; - /** - * The name of the CWE. - */ - name: string; - }[] - | null; - /** - * A list of only the CWE IDs. - */ - cwe_ids: string[] | null; - credits: - | { - /** - * The username of the user credited. - */ - login?: string; - type?: SecurityAdvisoryCreditTypes; - }[] - | null; - credits_detailed: RepositoryAdvisoryCredit[] | null; -}; export type RepositoryAdvisoryCreate = { /** * A short summary of the advisory. @@ -14178,6 +15247,14 @@ export type RepositoryAdvisoryUpdate = { * The state of the advisory. */ state?: 'published' | 'closed' | 'draft'; + /** + * A list of usernames who have been granted write access to the advisory. + */ + collaborating_users?: string[] | null; + /** + * A list of team slugs which have been granted write access to the advisory. + */ + collaborating_teams?: string[] | null; }; /** * Stargazer @@ -15378,9 +16455,59 @@ export type KeySimple = { id: number; key: string; }; +/** + * Enterprise + * An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + */ +export type EnterpriseWebhooks = { + /** + * A short description of the enterprise. + */ + description?: string | null; + /** + * @example "https://github.com/enterprises/octo-business" + */ + html_url: string; + /** + * The enterprise's website URL. + */ + website_url?: string | null; + /** + * Unique identifier of the enterprise + * @example 42 + */ + id: number; + /** + * @example "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + */ + node_id: string; + /** + * The name of the enterprise. + * @example "Octo Business" + */ + name: string; + /** + * The slug url identifier for the enterprise. + * @example "octo-business" + */ + slug: string; + /** + * @example "2019-01-26T19:01:12Z" + */ + created_at: Date | null; + /** + * @example "2019-01-26T19:14:43Z" + */ + updated_at: Date | null; + avatar_url: string; +}; /** * Simple Installation - * The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App. + * The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ export type SimpleInstallation = { /** @@ -15395,1010 +16522,3947 @@ export type SimpleInstallation = { node_id: string; }; /** - * A suite of checks performed on the code of a given code change + * Organization Simple + * A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an + * organization, or when the event occurs from activity in a repository owned by an organization. */ -export type SimpleCheckSuite = { +export type OrganizationSimpleWebhooks = { /** - * @example "d6fde92930d4715a2b49857d24b940956b26d2d3" + * @example "github" */ - after?: string | null; - app?: Integration; + login: string; /** - * @example "146e867f55c26428e5f9fade55a9bbf5e95a7912" + * @example 1 */ - before?: string | null; + id: number; /** - * @example "neutral" + * @example "MDEyOk9yZ2FuaXphdGlvbjE=" */ - conclusion?: - | ( - | 'success' - | 'failure' - | 'neutral' - | 'cancelled' - | 'skipped' - | 'timed_out' - | 'action_required' - | 'stale' - | 'startup_failure' - ) - | null; - created_at?: Date; + node_id: string; /** - * @example "master" + * @example "https://api.github.com/orgs/github" */ - head_branch?: string | null; + url: string; /** - * The SHA of the head commit that is being checked. - * @example "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + * @example "https://api.github.com/orgs/github/repos" */ - head_sha?: string; + repos_url: string; /** - * @example 5 + * @example "https://api.github.com/orgs/github/events" */ - id?: number; + events_url: string; /** - * @example "MDEwOkNoZWNrU3VpdGU1" + * @example "https://api.github.com/orgs/github/hooks" */ - node_id?: string; - pull_requests?: PullRequestMinimal[]; - repository?: MinimalRepository; + hooks_url: string; /** - * @example "completed" + * @example "https://api.github.com/orgs/github/issues" */ - status?: 'queued' | 'in_progress' | 'completed' | 'pending' | 'waiting'; - updated_at?: Date; + issues_url: string; /** - * @example "https://api.github.com/repos/github/hello-world/check-suites/5" + * @example "https://api.github.com/orgs/github/members{/member}" */ - url?: string; + members_url: string; + /** + * @example "https://api.github.com/orgs/github/public_members{/member}" + */ + public_members_url: string; + /** + * @example "https://github.com/images/error/octocat_happy.gif" + */ + avatar_url: string; + /** + * @example "A great organization" + */ + description: string | null; }; /** - * CheckRun - * A check performed on the code of a given code change + * Repository + * The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + * when the event occurs from activity in a repository. */ -export type CheckRunWithSimpleCheckSuite = { - app: NullableIntegration; - check_suite: SimpleCheckSuite; +export type RepositoryWebhooks = { /** - * @example "2018-05-04T01:14:52Z" + * Unique identifier of the repository + * @example 42 */ - completed_at: Date | null; + id: number; /** - * @example "neutral" + * @example "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" */ - conclusion: - | ( - | 'waiting' - | 'pending' - | 'startup_failure' - | 'stale' - | 'success' - | 'failure' - | 'neutral' - | 'cancelled' - | 'skipped' - | 'timed_out' - | 'action_required' - ) - | null; - deployment?: DeploymentSimple; + node_id: string; /** - * @example "https://example.com" + * The name of the repository. + * @example "Team Environment" */ - details_url: string; + name: string; /** - * @example "42" + * @example "octocat/Hello-World" */ - external_id: string; + full_name: string; + license: NullableLicenseSimple; + organization?: NullableSimpleUser; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: SimpleUser; /** - * The SHA of the commit that is being checked. - * @example "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + * Whether the repository is private or public. */ - head_sha: string; + private: boolean; /** - * @example "https://github.com/github/hello-world/runs/4" + * @example "https://github.com/octocat/Hello-World" */ html_url: string; /** - * The id of the check. - * @example 21 + * @example "This your first repo!" */ - id: number; + description: string | null; + fork: boolean; /** - * The name of the check. - * @example "test-coverage" + * @example "https://api.github.com/repos/octocat/Hello-World" */ - name: string; + url: string; /** - * @example "MDg6Q2hlY2tSdW40" + * @example "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" */ - node_id: string; - output: { - annotations_count: number; - annotations_url: string; - summary: string | null; - text: string | null; - title: string | null; - }; - pull_requests: PullRequestMinimal[]; + archive_url: string; /** - * @example "2018-05-04T01:14:52Z" + * @example "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" */ - started_at: Date; + assignees_url: string; /** - * The phase of the lifecycle that the check is currently in. - * @example "queued" + * @example "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" */ - status: 'queued' | 'in_progress' | 'completed' | 'pending'; + blobs_url: string; /** - * @example "https://api.github.com/repos/github/hello-world/check-runs/4" + * @example "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" */ - url: string; -}; -/** - * Discussion - * A Discussion in a repository. - */ -export type Discussion = { - active_lock_reason: string | null; - answer_chosen_at: string | null; + branches_url: string; /** - * User + * @example "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" */ - answer_chosen_by: { - avatar_url?: string; - deleted?: boolean; - email?: string | null; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: 'Bot' | 'User' | 'Organization'; - url?: string; - } | null; - answer_html_url: string | null; + collaborators_url: string; /** - * AuthorAssociation - * How the author is associated with the repository. + * @example "http://api.github.com/repos/octocat/Hello-World/comments{/number}" */ - author_association: - | 'COLLABORATOR' - | 'CONTRIBUTOR' - | 'FIRST_TIMER' - | 'FIRST_TIME_CONTRIBUTOR' - | 'MANNEQUIN' - | 'MEMBER' - | 'NONE' - | 'OWNER'; - body: string; - category: { - created_at: Date; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; - created_at: Date; - html_url: string; - id: number; - locked: boolean; - node_id: string; - number: number; + comments_url: string; /** - * Reactions + * @example "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" */ - reactions?: { - '+1': number; - '-1': number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; - }; - repository_url: string; + commits_url: string; /** - * The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * @example "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" */ - state: 'open' | 'closed' | 'locked' | 'converting' | 'transferring'; + compare_url: string; /** - * The reason for the current state - * @example "resolved" + * @example "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" */ - state_reason: ('resolved' | 'outdated' | 'duplicate' | 'reopened') | null; - timeline_url?: string; - title: string; - updated_at: Date; + contents_url: string; /** - * User + * @example "http://api.github.com/repos/octocat/Hello-World/contributors" */ - user: { - avatar_url?: string; - deleted?: boolean; - email?: string | null; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: 'Bot' | 'User' | 'Organization'; - url?: string; - } | null; -}; -/** - * Merge Group - * A group of pull requests that the merge queue has grouped together to be merged. - */ -export type MergeGroup = { + contributors_url: string; /** - * The SHA of the merge group. + * @example "http://api.github.com/repos/octocat/Hello-World/deployments" */ - head_sha: string; + deployments_url: string; /** - * The full ref of the merge group. + * @example "http://api.github.com/repos/octocat/Hello-World/downloads" */ - head_ref: string; + downloads_url: string; /** - * The SHA of the merge group's parent commit. + * @example "http://api.github.com/repos/octocat/Hello-World/events" */ - base_sha: string; + events_url: string; /** - * The full ref of the branch the merge group will be merged into. + * @example "http://api.github.com/repos/octocat/Hello-World/forks" */ - base_ref: string; - head_commit: SimpleCommit; -}; -/** - * Personal Access Token Request - * Details of a Personal Access Token Request. - */ -export type PersonalAccessTokenRequest = { + forks_url: string; /** - * Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. + * @example "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" */ - id: number; - owner: SimpleUser; + git_commits_url: string; /** - * New requested permissions, categorized by type of permission. + * @example "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" */ - permissions_added: { - organization?: { - [key: string]: string; - }; - repository?: { - [key: string]: string; - }; - other?: { - [key: string]: string; - }; - }; + git_refs_url: string; /** - * Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. + * @example "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" */ - permissions_upgraded: { - organization?: { - [key: string]: string; - }; - repository?: { - [key: string]: string; - }; - other?: { - [key: string]: string; - }; - }; + git_tags_url: string; /** - * Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. + * @example "git:github.com/octocat/Hello-World.git" */ - permissions_result: { - organization?: { - [key: string]: string; - }; - repository?: { - [key: string]: string; - }; - other?: { - [key: string]: string; - }; - }; + git_url: string; /** - * Type of repository selection requested. + * @example "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" */ - repository_selection: 'none' | 'all' | 'subset'; + issue_comment_url: string; /** - * The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + * @example "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" */ - repository_count: number | null; + issue_events_url: string; /** - * An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + * @example "http://api.github.com/repos/octocat/Hello-World/issues{/number}" */ - repositories: - | { - full_name: string; - /** - * Unique identifier of the repository - */ - id: number; - /** - * The name of the repository. - */ - name: string; - node_id: string; - /** - * Whether the repository is private or public. - */ - private: boolean; - }[] - | null; + issues_url: string; /** - * Date and time when the request for access was created. + * @example "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" */ - created_at: string; + keys_url: string; /** - * Whether the associated fine-grained personal access token has expired. + * @example "http://api.github.com/repos/octocat/Hello-World/labels{/name}" */ - token_expired: boolean; + labels_url: string; /** - * Date and time when the associated fine-grained personal access token expires. + * @example "http://api.github.com/repos/octocat/Hello-World/languages" */ - token_expires_at: string | null; + languages_url: string; /** - * Date and time when the associated fine-grained personal access token was last used for authentication. + * @example "http://api.github.com/repos/octocat/Hello-World/merges" */ - token_last_used_at: string | null; -}; -/** - * Projects v2 Project - * A projects v2 project - */ -export type ProjectsV2 = { - id: number; - node_id: string; - owner: SimpleUser; - creator: SimpleUser; - title: string; - description: string | null; - public: boolean; + merges_url: string; /** - * @example "2022-04-28T12:00:00Z" + * @example "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" */ - closed_at: Date | null; + milestones_url: string; /** - * @example "2022-04-28T12:00:00Z" + * @example "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" */ - created_at: Date; + notifications_url: string; /** - * @example "2022-04-28T12:00:00Z" + * @example "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" */ - updated_at: Date; - number: number; - short_description: string | null; + pulls_url: string; /** - * @example "2022-04-28T12:00:00Z" + * @example "http://api.github.com/repos/octocat/Hello-World/releases{/id}" */ - deleted_at: Date | null; - deleted_by: NullableSimpleUser; -}; -/** - * Projects v2 Item Content Type - * The type of content tracked in a project item - */ -export enum ProjectsV2ItemContentType { - ISSUE = 'Issue', - PULL_REQUEST = 'PullRequest', - DRAFT_ISSUE = 'DraftIssue', -} -/** - * Projects v2 Item - * An item belonging to a project - */ -export type ProjectsV2Item = { - id: number; - node_id?: string; - project_node_id?: string; - content_node_id: string; - content_type: ProjectsV2ItemContentType; - creator?: SimpleUser; + releases_url: string; /** - * @example "2022-04-28T12:00:00Z" + * @example "git@github.com:octocat/Hello-World.git" */ - created_at: Date; + ssh_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/stargazers" + */ + stargazers_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + */ + statuses_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/subscribers" + */ + subscribers_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/subscription" + */ + subscription_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/tags" + */ + tags_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/teams" + */ + teams_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + */ + trees_url: string; + /** + * @example "https://github.com/octocat/Hello-World.git" + */ + clone_url: string; + /** + * @example "git:git.example.com/octocat/Hello-World" + */ + mirror_url: string | null; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/hooks" + */ + hooks_url: string; + /** + * @example "https://svn.github.com/octocat/Hello-World" + */ + svn_url: string; + /** + * @example "https://github.com" + */ + homepage: string | null; + language: string | null; + /** + * @example 9 + */ + forks_count: number; + /** + * @example 80 + */ + stargazers_count: number; + /** + * @example 80 + */ + watchers_count: number; + /** + * The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ + size: number; + /** + * The default branch of the repository. + * @example "master" + */ + default_branch: string; + open_issues_count: number; + /** + * Whether this repository acts as a template that can be used to generate new repositories. + * @example true + */ + is_template?: boolean; + topics?: string[]; + /** + * Whether issues are enabled. + * @example true + * @defaultValue true + */ + has_issues: boolean; + /** + * Whether projects are enabled. + * @example true + * @defaultValue true + */ + has_projects: boolean; + /** + * Whether the wiki is enabled. + * @example true + * @defaultValue true + */ + has_wiki: boolean; + has_pages: boolean; + /** + * Whether downloads are enabled. + * @example true + * @defaultValue true + */ + has_downloads: boolean; + /** + * Whether discussions are enabled. + * @example true + */ + has_discussions?: boolean; + /** + * Whether the repository is archived. + */ + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + /** + * The repository visibility: public, private, or internal. + * @defaultValue "public" + */ + visibility?: string; + /** + * @example "2011-01-26T19:06:43Z" + */ + pushed_at: Date | null; + /** + * @example "2011-01-26T19:01:12Z" + */ + created_at: Date | null; + /** + * @example "2011-01-26T19:14:43Z" + */ + updated_at: Date | null; + /** + * Whether to allow rebase merges for pull requests. + * @example true + * @defaultValue true + */ + allow_rebase_merge?: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; + /** + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + */ + squash_merge_commit_title?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + /** + * The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + */ + squash_merge_commit_message?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + /** + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + */ + merge_commit_title?: 'PR_TITLE' | 'MERGE_MESSAGE'; + /** + * The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + */ + merge_commit_message?: 'PR_BODY' | 'PR_TITLE' | 'BLANK'; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } | null; + temp_clone_token?: string; + /** + * Whether to allow squash merges for pull requests. + * @example true + * @defaultValue true + */ + allow_squash_merge?: boolean; + /** + * Whether to allow Auto-merge to be used on pull requests. + */ + allow_auto_merge?: boolean; + /** + * Whether to delete head branches when pull requests are merged + */ + delete_branch_on_merge?: boolean; + /** + * Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + */ + allow_update_branch?: boolean; + /** + * Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @deprecated + */ + use_squash_pr_title_as_default?: boolean; + /** + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + */ + squash_merge_commit_title?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + /** + * The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + */ + squash_merge_commit_message?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + /** + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + */ + merge_commit_title?: 'PR_TITLE' | 'MERGE_MESSAGE'; + /** + * The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + */ + merge_commit_message?: 'PR_BODY' | 'PR_TITLE' | 'BLANK'; + /** + * Whether to allow merge commits for pull requests. + * @example true + * @defaultValue true + */ + allow_merge_commit?: boolean; + /** + * Whether to allow forking this repo + */ + allow_forking?: boolean; + /** + * Whether to require contributors to sign off on web-based commits + */ + web_commit_signoff_required?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + /** + * @example "\"2020-07-09T00:17:42Z\"" + */ + starred_at?: string; + /** + * Whether anonymous git access is enabled for this repository + */ + anonymous_access_enabled?: boolean; +}; +/** + * Simple User + * The GitHub user that triggered the event. This property is included in every webhook payload. + */ +export type SimpleUserWebhooks = { + name?: string | null; + email?: string | null; + /** + * @example "octocat" + */ + login: string; + /** + * @example 1 + */ + id: number; + /** + * @example "MDQ6VXNlcjE=" + */ + node_id: string; + /** + * @example "https://github.com/images/error/octocat_happy.gif" + */ + avatar_url: string; + /** + * @example "41d064eb2195891e12d0413f63227ea7" + */ + gravatar_id: string | null; + /** + * @example "https://api.github.com/users/octocat" + */ + url: string; + /** + * @example "https://github.com/octocat" + */ + html_url: string; + /** + * @example "https://api.github.com/users/octocat/followers" + */ + followers_url: string; + /** + * @example "https://api.github.com/users/octocat/following{/other_user}" + */ + following_url: string; + /** + * @example "https://api.github.com/users/octocat/gists{/gist_id}" + */ + gists_url: string; + /** + * @example "https://api.github.com/users/octocat/starred{/owner}{/repo}" + */ + starred_url: string; + /** + * @example "https://api.github.com/users/octocat/subscriptions" + */ + subscriptions_url: string; + /** + * @example "https://api.github.com/users/octocat/orgs" + */ + organizations_url: string; + /** + * @example "https://api.github.com/users/octocat/repos" + */ + repos_url: string; + /** + * @example "https://api.github.com/users/octocat/events{/privacy}" + */ + events_url: string; + /** + * @example "https://api.github.com/users/octocat/received_events" + */ + received_events_url: string; + /** + * @example "User" + */ + type: string; + site_admin: boolean; + /** + * @example "\"2020-07-09T00:17:55Z\"" + */ + starred_at?: string; +}; +/** + * A suite of checks performed on the code of a given code change + */ +export type SimpleCheckSuite = { + /** + * @example "d6fde92930d4715a2b49857d24b940956b26d2d3" + */ + after?: string | null; + app?: Integration; + /** + * @example "146e867f55c26428e5f9fade55a9bbf5e95a7912" + */ + before?: string | null; + /** + * @example "neutral" + */ + conclusion?: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'skipped' + | 'timed_out' + | 'action_required' + | 'stale' + | 'startup_failure' + ) + | null; + created_at?: Date; + /** + * @example "master" + */ + head_branch?: string | null; + /** + * The SHA of the head commit that is being checked. + * @example "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + */ + head_sha?: string; + /** + * @example 5 + */ + id?: number; + /** + * @example "MDEwOkNoZWNrU3VpdGU1" + */ + node_id?: string; + pull_requests?: PullRequestMinimal[]; + repository?: MinimalRepository; + /** + * @example "completed" + */ + status?: 'queued' | 'in_progress' | 'completed' | 'pending' | 'waiting'; + updated_at?: Date; + /** + * @example "https://api.github.com/repos/github/hello-world/check-suites/5" + */ + url?: string; +}; +/** + * CheckRun + * A check performed on the code of a given code change + */ +export type CheckRunWithSimpleCheckSuite = { + app: NullableIntegration; + check_suite: SimpleCheckSuite; + /** + * @example "2018-05-04T01:14:52Z" + */ + completed_at: Date | null; + /** + * @example "neutral" + */ + conclusion: + | ( + | 'waiting' + | 'pending' + | 'startup_failure' + | 'stale' + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'skipped' + | 'timed_out' + | 'action_required' + ) + | null; + deployment?: DeploymentSimple; + /** + * @example "https://example.com" + */ + details_url: string; + /** + * @example "42" + */ + external_id: string; + /** + * The SHA of the commit that is being checked. + * @example "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + */ + head_sha: string; + /** + * @example "https://github.com/github/hello-world/runs/4" + */ + html_url: string; + /** + * The id of the check. + * @example 21 + */ + id: number; + /** + * The name of the check. + * @example "test-coverage" + */ + name: string; + /** + * @example "MDg6Q2hlY2tSdW40" + */ + node_id: string; + output: { + annotations_count: number; + annotations_url: string; + summary: string | null; + text: string | null; + title: string | null; + }; + pull_requests: PullRequestMinimal[]; + /** + * @example "2018-05-04T01:14:52Z" + */ + started_at: Date; + /** + * The phase of the lifecycle that the check is currently in. + * @example "queued" + */ + status: 'queued' | 'in_progress' | 'completed' | 'pending'; + /** + * @example "https://api.github.com/repos/github/hello-world/check-runs/4" + */ + url: string; +}; +/** + * Discussion + * A Discussion in a repository. + */ +export type Discussion = { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** + * User + */ + answer_chosen_by: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * How the author is associated with the repository. + */ + author_association: + | 'COLLABORATOR' + | 'CONTRIBUTOR' + | 'FIRST_TIMER' + | 'FIRST_TIME_CONTRIBUTOR' + | 'MANNEQUIN' + | 'MEMBER' + | 'NONE' + | 'OWNER'; + body: string; + category: { + created_at: Date; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + created_at: Date; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** + * Reactions + */ + reactions?: { + '+1': number; + '-1': number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + url: string; + }; + repository_url: string; + /** + * The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + */ + state: 'open' | 'closed' | 'locked' | 'converting' | 'transferring'; + /** + * The reason for the current state + * @example "resolved" + */ + state_reason: ('resolved' | 'outdated' | 'duplicate' | 'reopened') | null; + timeline_url?: string; + title: string; + updated_at: Date; + /** + * User + */ + user: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; +}; +/** + * Merge Group + * A group of pull requests that the merge queue has grouped together to be merged. + */ +export type MergeGroup = { + /** + * The SHA of the merge group. + */ + head_sha: string; + /** + * The full ref of the merge group. + */ + head_ref: string; + /** + * The SHA of the merge group's parent commit. + */ + base_sha: string; + /** + * The full ref of the branch the merge group will be merged into. + */ + base_ref: string; + head_commit: SimpleCommit; +}; +/** + * Repository + * The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + * when the event occurs from activity in a repository. + */ +export type NullableRepositoryWebhooks = { + /** + * Unique identifier of the repository + * @example 42 + */ + id: number; + /** + * @example "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + */ + node_id: string; + /** + * The name of the repository. + * @example "Team Environment" + */ + name: string; + /** + * @example "octocat/Hello-World" + */ + full_name: string; + license: NullableLicenseSimple; + organization?: NullableSimpleUser; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: SimpleUser; + /** + * Whether the repository is private or public. + */ + private: boolean; + /** + * @example "https://github.com/octocat/Hello-World" + */ + html_url: string; + /** + * @example "This your first repo!" + */ + description: string | null; + fork: boolean; + /** + * @example "https://api.github.com/repos/octocat/Hello-World" + */ + url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + */ + archive_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + */ + assignees_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + */ + blobs_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + */ + branches_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + */ + collaborators_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + */ + comments_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + */ + commits_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + */ + compare_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + */ + contents_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/contributors" + */ + contributors_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/deployments" + */ + deployments_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/downloads" + */ + downloads_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/events" + */ + events_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/forks" + */ + forks_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + */ + git_commits_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + */ + git_refs_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + */ + git_tags_url: string; + /** + * @example "git:github.com/octocat/Hello-World.git" + */ + git_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + */ + issue_comment_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + */ + issue_events_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + */ + issues_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + */ + keys_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + */ + labels_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/languages" + */ + languages_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/merges" + */ + merges_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + */ + milestones_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + */ + notifications_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + */ + pulls_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + */ + releases_url: string; + /** + * @example "git@github.com:octocat/Hello-World.git" + */ + ssh_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/stargazers" + */ + stargazers_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + */ + statuses_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/subscribers" + */ + subscribers_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/subscription" + */ + subscription_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/tags" + */ + tags_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/teams" + */ + teams_url: string; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + */ + trees_url: string; + /** + * @example "https://github.com/octocat/Hello-World.git" + */ + clone_url: string; + /** + * @example "git:git.example.com/octocat/Hello-World" + */ + mirror_url: string | null; + /** + * @example "http://api.github.com/repos/octocat/Hello-World/hooks" + */ + hooks_url: string; + /** + * @example "https://svn.github.com/octocat/Hello-World" + */ + svn_url: string; + /** + * @example "https://github.com" + */ + homepage: string | null; + language: string | null; + /** + * @example 9 + */ + forks_count: number; + /** + * @example 80 + */ + stargazers_count: number; + /** + * @example 80 + */ + watchers_count: number; + /** + * The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ + size: number; + /** + * The default branch of the repository. + * @example "master" + */ + default_branch: string; + open_issues_count: number; + /** + * Whether this repository acts as a template that can be used to generate new repositories. + * @example true + */ + is_template?: boolean; + topics?: string[]; + /** + * Whether issues are enabled. + * @example true + * @defaultValue true + */ + has_issues: boolean; + /** + * Whether projects are enabled. + * @example true + * @defaultValue true + */ + has_projects: boolean; + /** + * Whether the wiki is enabled. + * @example true + * @defaultValue true + */ + has_wiki: boolean; + has_pages: boolean; + /** + * Whether downloads are enabled. + * @example true + * @defaultValue true + */ + has_downloads: boolean; + /** + * Whether discussions are enabled. + * @example true + */ + has_discussions?: boolean; + /** + * Whether the repository is archived. + */ + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + /** + * The repository visibility: public, private, or internal. + * @defaultValue "public" + */ + visibility?: string; + /** + * @example "2011-01-26T19:06:43Z" + */ + pushed_at: Date | null; + /** + * @example "2011-01-26T19:01:12Z" + */ + created_at: Date | null; + /** + * @example "2011-01-26T19:14:43Z" + */ + updated_at: Date | null; + /** + * Whether to allow rebase merges for pull requests. + * @example true + * @defaultValue true + */ + allow_rebase_merge?: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; + /** + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + */ + squash_merge_commit_title?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + /** + * The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + */ + squash_merge_commit_message?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + /** + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + */ + merge_commit_title?: 'PR_TITLE' | 'MERGE_MESSAGE'; + /** + * The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + */ + merge_commit_message?: 'PR_BODY' | 'PR_TITLE' | 'BLANK'; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } | null; + temp_clone_token?: string; + /** + * Whether to allow squash merges for pull requests. + * @example true + * @defaultValue true + */ + allow_squash_merge?: boolean; + /** + * Whether to allow Auto-merge to be used on pull requests. + */ + allow_auto_merge?: boolean; + /** + * Whether to delete head branches when pull requests are merged + */ + delete_branch_on_merge?: boolean; + /** + * Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + */ + allow_update_branch?: boolean; + /** + * Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @deprecated + */ + use_squash_pr_title_as_default?: boolean; + /** + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + */ + squash_merge_commit_title?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE'; + /** + * The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + */ + squash_merge_commit_message?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK'; + /** + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + */ + merge_commit_title?: 'PR_TITLE' | 'MERGE_MESSAGE'; + /** + * The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + */ + merge_commit_message?: 'PR_BODY' | 'PR_TITLE' | 'BLANK'; + /** + * Whether to allow merge commits for pull requests. + * @example true + * @defaultValue true + */ + allow_merge_commit?: boolean; + /** + * Whether to allow forking this repo + */ + allow_forking?: boolean; + /** + * Whether to require contributors to sign off on web-based commits + */ + web_commit_signoff_required?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + /** + * @example "\"2020-07-09T00:17:42Z\"" + */ + starred_at?: string; + /** + * Whether anonymous git access is enabled for this repository + */ + anonymous_access_enabled?: boolean; +} | null; +/** + * Personal Access Token Request + * Details of a Personal Access Token Request. + */ +export type PersonalAccessTokenRequest = { + /** + * Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. + */ + id: number; + owner: SimpleUser; + /** + * New requested permissions, categorized by type of permission. + */ + permissions_added: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** + * Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. + */ + permissions_upgraded: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** + * Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. + */ + permissions_result: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** + * Type of repository selection requested. + */ + repository_selection: 'none' | 'all' | 'subset'; + /** + * The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ + repository_count: number | null; + /** + * An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ + repositories: + | { + full_name: string; + /** + * Unique identifier of the repository + */ + id: number; + /** + * The name of the repository. + */ + name: string; + node_id: string; + /** + * Whether the repository is private or public. + */ + private: boolean; + }[] + | null; + /** + * Date and time when the request for access was created. + */ + created_at: string; + /** + * Whether the associated fine-grained personal access token has expired. + */ + token_expired: boolean; + /** + * Date and time when the associated fine-grained personal access token expires. + */ + token_expires_at: string | null; + /** + * Date and time when the associated fine-grained personal access token was last used for authentication. + */ + token_last_used_at: string | null; +}; +/** + * Projects v2 Project + * A projects v2 project + */ +export type ProjectsV2 = { + id: number; + node_id: string; + owner: SimpleUser; + creator: SimpleUser; + title: string; + description: string | null; + public: boolean; + /** + * @example "2022-04-28T12:00:00Z" + */ + closed_at: Date | null; + /** + * @example "2022-04-28T12:00:00Z" + */ + created_at: Date; + /** + * @example "2022-04-28T12:00:00Z" + */ + updated_at: Date; + number: number; + short_description: string | null; + /** + * @example "2022-04-28T12:00:00Z" + */ + deleted_at: Date | null; + deleted_by: NullableSimpleUser; +}; +/** + * Projects v2 Item Content Type + * The type of content tracked in a project item + */ +export enum ProjectsV2ItemContentType { + ISSUE = 'Issue', + PULL_REQUEST = 'PullRequest', + DRAFT_ISSUE = 'DraftIssue', +} +/** + * Projects v2 Item + * An item belonging to a project + */ +export type ProjectsV2Item = { + id: number; + node_id?: string; + project_node_id?: string; + content_node_id: string; + content_type: ProjectsV2ItemContentType; + creator?: SimpleUser; + /** + * @example "2022-04-28T12:00:00Z" + */ + created_at: Date; + /** + * @example "2022-04-28T12:00:00Z" + */ + updated_at: Date; /** * @example "2022-04-28T12:00:00Z" */ - updated_at: Date; + archived_at: Date | null; +}; +/** + * The reason for resolving the alert. + */ +export type SecretScanningAlertResolutionWebhook = + | ( + | 'false_positive' + | 'wont_fix' + | 'revoked' + | 'used_in_tests' + | 'pattern_deleted' + | 'pattern_edited' + ) + | null; +export type SecretScanningAlertWebhook = { + number?: AlertNumber; + created_at?: AlertCreatedAt; + updated_at?: NullableAlertUpdatedAt; + url?: AlertUrl; + html_url?: AlertHtmlUrl; + /** + * The REST API URL of the code locations for this alert. + */ + locations_url?: string; + resolution?: SecretScanningAlertResolutionWebhook; + /** + * The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: Date | null; + resolved_by?: NullableSimpleUser; + /** + * An optional comment to resolve an alert. + */ + resolution_comment?: string | null; + /** + * The type of secret that secret scanning detected. + */ + secret_type?: string; + /** + * Whether push protection was bypassed for the detected secret. + */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: NullableSimpleUser; + /** + * The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: Date | null; +}; +/** + * branch protection configuration disabled event + */ +export type WebhookBranchProtectionConfigurationDisabled = { + action: 'disabled'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * branch protection configuration enabled event + */ +export type WebhookBranchProtectionConfigurationEnabled = { + action: 'enabled'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * branch protection rule created event + */ +export type WebhookBranchProtectionRuleCreated = { + action: 'created'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + /** + * branch protection rule + * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + rule: { + admin_enforced: boolean; + allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; + allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + created_at: Date; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + linear_history_requirement_enforcement_level: + | 'off' + | 'non_admins' + | 'everyone'; + merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; + name: string; + pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; + repository_id: number; + require_code_owner_review: boolean; + /** + * Whether the most recent push must be approved by someone other than the person who pushed it + */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; + required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; + required_status_checks: string[]; + required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; + signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; + strict_required_status_checks_policy: boolean; + updated_at: Date; + }; + sender: SimpleUserWebhooks; +}; +/** + * branch protection rule deleted event + */ +export type WebhookBranchProtectionRuleDeleted = { + action: 'deleted'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + /** + * branch protection rule + * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + rule: { + admin_enforced: boolean; + allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; + allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + created_at: Date; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + linear_history_requirement_enforcement_level: + | 'off' + | 'non_admins' + | 'everyone'; + merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; + name: string; + pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; + repository_id: number; + require_code_owner_review: boolean; + /** + * Whether the most recent push must be approved by someone other than the person who pushed it + */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; + required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; + required_status_checks: string[]; + required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; + signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; + strict_required_status_checks_policy: boolean; + updated_at: Date; + }; + sender: SimpleUserWebhooks; +}; +/** + * branch protection rule edited event + */ +export type WebhookBranchProtectionRuleEdited = { + action: 'edited'; + /** + * If the action was `edited`, the changes to the rule. + */ + changes?: { + admin_enforced?: { + from: boolean | null; + }; + authorized_actor_names?: { + from: string[]; + }; + authorized_actors_only?: { + from: boolean | null; + }; + authorized_dismissal_actors_only?: { + from: boolean | null; + }; + linear_history_requirement_enforcement_level?: { + from: 'off' | 'non_admins' | 'everyone'; + }; + required_status_checks?: { + from: string[]; + }; + required_status_checks_enforcement_level?: { + from: 'off' | 'non_admins' | 'everyone'; + }; + }; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + /** + * branch protection rule + * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + rule: { + admin_enforced: boolean; + allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; + allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + created_at: Date; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + linear_history_requirement_enforcement_level: + | 'off' + | 'non_admins' + | 'everyone'; + merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; + name: string; + pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; + repository_id: number; + require_code_owner_review: boolean; + /** + * Whether the most recent push must be approved by someone other than the person who pushed it + */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; + required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; + required_status_checks: string[]; + required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; + signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; + strict_required_status_checks_policy: boolean; + updated_at: Date; + }; + sender: SimpleUserWebhooks; +}; +/** + * Check Run Completed Event + */ +export type WebhookCheckRunCompleted = { + action?: 'completed'; + check_run: CheckRunWithSimpleCheckSuite; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * Check Run Completed Event + * The check_run.completed webhook encoded with URL encoding + */ +export type WebhookCheckRunCompletedFormEncoded = { + /** + * A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. + */ + payload: string; +}; +/** + * Check Run Created Event + */ +export type WebhookCheckRunCreated = { + action?: 'created'; + check_run: CheckRunWithSimpleCheckSuite; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * Check Run Created Event + * The check_run.created webhook encoded with URL encoding + */ +export type WebhookCheckRunCreatedFormEncoded = { + /** + * A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. + */ + payload: string; +}; +/** + * Check Run Requested Action Event + */ +export type WebhookCheckRunRequestedAction = { + action: 'requested_action'; + check_run: CheckRunWithSimpleCheckSuite; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + /** + * The action requested by the user. + */ + requested_action?: { + /** + * The integrator reference of the action requested by the user. + */ + identifier?: string; + }; + sender: SimpleUserWebhooks; +}; +/** + * Check Run Requested Action Event + * The check_run.requested_action webhook encoded with URL encoding + */ +export type WebhookCheckRunRequestedActionFormEncoded = { + /** + * A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. + */ + payload: string; +}; +/** + * Check Run Re-Requested Event + */ +export type WebhookCheckRunRerequested = { + action?: 'rerequested'; + check_run: CheckRunWithSimpleCheckSuite; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * Check Run Re-Requested Event + * The check_run.rerequested webhook encoded with URL encoding + */ +export type WebhookCheckRunRerequestedFormEncoded = { + /** + * A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. + */ + payload: string; +}; +/** + * check_suite completed event + */ +export type WebhookCheckSuiteCompleted = { + action: 'completed'; + /** + * The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + */ + check_suite: { + after: string | null; + /** + * App + * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + app: { + created_at: Date | null; + description: string | null; + /** + * The list of events for the GitHub app + */ + events?: ( + | 'branch_protection_rule' + | 'check_run' + | 'check_suite' + | 'code_scanning_alert' + | 'commit_comment' + | 'content_reference' + | 'create' + | 'delete' + | 'deployment' + | 'deployment_review' + | 'deployment_status' + | 'deploy_key' + | 'discussion' + | 'discussion_comment' + | 'fork' + | 'gollum' + | 'issues' + | 'issue_comment' + | 'label' + | 'member' + | 'membership' + | 'milestone' + | 'organization' + | 'org_block' + | 'page_build' + | 'project' + | 'project_card' + | 'project_column' + | 'public' + | 'pull_request' + | 'pull_request_review' + | 'pull_request_review_comment' + | 'push' + | 'registry_package' + | 'release' + | 'repository' + | 'repository_dispatch' + | 'secret_scanning_alert' + | 'star' + | 'status' + | 'team' + | 'team_add' + | 'watch' + | 'workflow_dispatch' + | 'workflow_run' + | 'merge_group' + | 'pull_request_review_thread' + | 'workflow_job' + | 'merge_queue_entry' + | 'security_and_analysis' + | 'projects_v2_item' + | 'secret_scanning_alert_location' + )[]; + external_url: string | null; + html_url: string; + /** + * Unique identifier of the GitHub app + */ + id: number | null; + /** + * The name of the GitHub app + */ + name: string; + node_id: string; + /** + * User + */ + owner: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The set of permissions for the GitHub app + */ + permissions?: { + actions?: 'read' | 'write'; + administration?: 'read' | 'write'; + checks?: 'read' | 'write'; + content_references?: 'read' | 'write'; + contents?: 'read' | 'write'; + deployments?: 'read' | 'write'; + discussions?: 'read' | 'write'; + emails?: 'read' | 'write'; + environments?: 'read' | 'write'; + issues?: 'read' | 'write'; + keys?: 'read' | 'write'; + members?: 'read' | 'write'; + metadata?: 'read' | 'write'; + organization_administration?: 'read' | 'write'; + organization_hooks?: 'read' | 'write'; + organization_packages?: 'read' | 'write'; + organization_plan?: 'read' | 'write'; + organization_projects?: 'read' | 'write' | 'admin'; + organization_secrets?: 'read' | 'write'; + organization_self_hosted_runners?: 'read' | 'write'; + organization_user_blocking?: 'read' | 'write'; + packages?: 'read' | 'write'; + pages?: 'read' | 'write'; + pull_requests?: 'read' | 'write'; + repository_hooks?: 'read' | 'write'; + repository_projects?: 'read' | 'write' | 'admin'; + secret_scanning_alerts?: 'read' | 'write'; + secrets?: 'read' | 'write'; + security_events?: 'read' | 'write'; + security_scanning_alert?: 'read' | 'write'; + single_file?: 'read' | 'write'; + statuses?: 'read' | 'write'; + team_discussions?: 'read' | 'write'; + vulnerability_alerts?: 'read' | 'write'; + workflows?: 'read' | 'write'; + }; + /** + * The slug name of the GitHub app + */ + slug?: string; + updated_at: Date | null; + }; + before: string | null; + check_runs_url: string; + /** + * The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. + */ + conclusion: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'timed_out' + | 'action_required' + | 'stale' + | null + | 'skipped' + | 'startup_failure' + ) + | null; + created_at: Date; + /** + * The head branch name the changes are on. + */ + head_branch: string | null; + /** + * SimpleCommit + */ + head_commit: { + /** + * Committer + * Metaproperties for Git author/committer information. + */ + author: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + /** + * Committer + * Metaproperties for Git author/committer information. + */ + committer: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** + * The SHA of the head commit that is being checked. + */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** + * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. + */ + pull_requests: { + base: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + id: number; + number: number; + url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + */ + status: + | ( + | 'requested' + | 'in_progress' + | 'completed' + | 'queued' + | null + | 'pending' + ) + | null; + updated_at: Date; + /** + * URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * check_suite requested event + */ +export type WebhookCheckSuiteRequested = { + action: 'requested'; + /** + * The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + */ + check_suite: { + after: string | null; + /** + * App + * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + app: { + created_at: Date | null; + description: string | null; + /** + * The list of events for the GitHub app + */ + events?: ( + | 'branch_protection_rule' + | 'check_run' + | 'check_suite' + | 'code_scanning_alert' + | 'commit_comment' + | 'content_reference' + | 'create' + | 'delete' + | 'deployment' + | 'deployment_review' + | 'deployment_status' + | 'deploy_key' + | 'discussion' + | 'discussion_comment' + | 'fork' + | 'gollum' + | 'issues' + | 'issue_comment' + | 'label' + | 'member' + | 'membership' + | 'milestone' + | 'organization' + | 'org_block' + | 'page_build' + | 'project' + | 'project_card' + | 'project_column' + | 'public' + | 'pull_request' + | 'pull_request_review' + | 'pull_request_review_comment' + | 'push' + | 'registry_package' + | 'release' + | 'repository' + | 'repository_dispatch' + | 'secret_scanning_alert' + | 'star' + | 'status' + | 'team' + | 'team_add' + | 'watch' + | 'workflow_dispatch' + | 'workflow_run' + | 'pull_request_review_thread' + | 'workflow_job' + | 'merge_queue_entry' + | 'security_and_analysis' + | 'secret_scanning_alert_location' + | 'projects_v2_item' + | 'merge_group' + | 'repository_import' + )[]; + external_url: string | null; + html_url: string; + /** + * Unique identifier of the GitHub app + */ + id: number | null; + /** + * The name of the GitHub app + */ + name: string; + node_id: string; + /** + * User + */ + owner: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The set of permissions for the GitHub app + */ + permissions?: { + actions?: 'read' | 'write'; + administration?: 'read' | 'write'; + checks?: 'read' | 'write'; + content_references?: 'read' | 'write'; + contents?: 'read' | 'write'; + deployments?: 'read' | 'write'; + discussions?: 'read' | 'write'; + emails?: 'read' | 'write'; + environments?: 'read' | 'write'; + issues?: 'read' | 'write'; + keys?: 'read' | 'write'; + members?: 'read' | 'write'; + metadata?: 'read' | 'write'; + organization_administration?: 'read' | 'write'; + organization_hooks?: 'read' | 'write'; + organization_packages?: 'read' | 'write'; + organization_plan?: 'read' | 'write'; + organization_projects?: 'read' | 'write' | 'admin'; + organization_secrets?: 'read' | 'write'; + organization_self_hosted_runners?: 'read' | 'write'; + organization_user_blocking?: 'read' | 'write'; + packages?: 'read' | 'write'; + pages?: 'read' | 'write'; + pull_requests?: 'read' | 'write'; + repository_hooks?: 'read' | 'write'; + repository_projects?: 'read' | 'write' | 'admin'; + secret_scanning_alerts?: 'read' | 'write'; + secrets?: 'read' | 'write'; + security_events?: 'read' | 'write'; + security_scanning_alert?: 'read' | 'write'; + single_file?: 'read' | 'write'; + statuses?: 'read' | 'write'; + team_discussions?: 'read' | 'write'; + vulnerability_alerts?: 'read' | 'write'; + workflows?: 'read' | 'write'; + }; + /** + * The slug name of the GitHub app + */ + slug?: string; + updated_at: Date | null; + }; + before: string | null; + check_runs_url: string; + /** + * The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + */ + conclusion: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'timed_out' + | 'action_required' + | 'stale' + | null + | 'skipped' + ) + | null; + created_at: Date; + /** + * The head branch name the changes are on. + */ + head_branch: string | null; + /** + * SimpleCommit + */ + head_commit: { + /** + * Committer + * Metaproperties for Git author/committer information. + */ + author: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + /** + * Committer + * Metaproperties for Git author/committer information. + */ + committer: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** + * The SHA of the head commit that is being checked. + */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** + * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. + */ + pull_requests: { + base: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + id: number; + number: number; + url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + */ + status: + | ('requested' | 'in_progress' | 'completed' | 'queued' | null) + | null; + updated_at: Date; + /** + * URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * check_suite rerequested event + */ +export type WebhookCheckSuiteRerequested = { + action: 'rerequested'; + /** + * The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + */ + check_suite: { + after: string | null; + /** + * App + * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + app: { + created_at: Date | null; + description: string | null; + /** + * The list of events for the GitHub app + */ + events?: ( + | 'branch_protection_rule' + | 'check_run' + | 'check_suite' + | 'code_scanning_alert' + | 'commit_comment' + | 'content_reference' + | 'create' + | 'delete' + | 'deployment' + | 'deployment_review' + | 'deployment_status' + | 'deploy_key' + | 'discussion' + | 'discussion_comment' + | 'fork' + | 'gollum' + | 'issues' + | 'issue_comment' + | 'label' + | 'member' + | 'membership' + | 'milestone' + | 'organization' + | 'org_block' + | 'page_build' + | 'project' + | 'project_card' + | 'project_column' + | 'public' + | 'pull_request' + | 'pull_request_review' + | 'pull_request_review_comment' + | 'push' + | 'registry_package' + | 'release' + | 'repository' + | 'repository_dispatch' + | 'secret_scanning_alert' + | 'star' + | 'status' + | 'team' + | 'team_add' + | 'watch' + | 'workflow_dispatch' + | 'workflow_run' + | 'pull_request_review_thread' + | 'merge_queue_entry' + | 'workflow_job' + )[]; + external_url: string | null; + html_url: string; + /** + * Unique identifier of the GitHub app + */ + id: number | null; + /** + * The name of the GitHub app + */ + name: string; + node_id: string; + /** + * User + */ + owner: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The set of permissions for the GitHub app + */ + permissions?: { + actions?: 'read' | 'write'; + administration?: 'read' | 'write'; + checks?: 'read' | 'write'; + content_references?: 'read' | 'write'; + contents?: 'read' | 'write'; + deployments?: 'read' | 'write'; + discussions?: 'read' | 'write'; + emails?: 'read' | 'write'; + environments?: 'read' | 'write'; + issues?: 'read' | 'write'; + keys?: 'read' | 'write'; + members?: 'read' | 'write'; + metadata?: 'read' | 'write'; + organization_administration?: 'read' | 'write'; + organization_hooks?: 'read' | 'write'; + organization_packages?: 'read' | 'write'; + organization_plan?: 'read' | 'write'; + organization_projects?: 'read' | 'write' | 'admin'; + organization_secrets?: 'read' | 'write'; + organization_self_hosted_runners?: 'read' | 'write'; + organization_user_blocking?: 'read' | 'write'; + packages?: 'read' | 'write'; + pages?: 'read' | 'write'; + pull_requests?: 'read' | 'write'; + repository_hooks?: 'read' | 'write'; + repository_projects?: 'read' | 'write' | 'admin'; + secret_scanning_alerts?: 'read' | 'write'; + secrets?: 'read' | 'write'; + security_events?: 'read' | 'write'; + security_scanning_alert?: 'read' | 'write'; + single_file?: 'read' | 'write'; + statuses?: 'read' | 'write'; + team_discussions?: 'read' | 'write'; + vulnerability_alerts?: 'read' | 'write'; + workflows?: 'read' | 'write'; + }; + /** + * The slug name of the GitHub app + */ + slug?: string; + updated_at: Date | null; + }; + before: string | null; + check_runs_url: string; + /** + * The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + */ + conclusion: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'timed_out' + | 'action_required' + | 'stale' + | null + ) + | null; + created_at: Date; + /** + * The head branch name the changes are on. + */ + head_branch: string | null; + /** + * SimpleCommit + */ + head_commit: { + /** + * Committer + * Metaproperties for Git author/committer information. + */ + author: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + /** + * Committer + * Metaproperties for Git author/committer information. + */ + committer: { + date?: Date; + email: string | null; + /** + * The git author's name. + */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** + * The SHA of the head commit that is being checked. + */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** + * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. + */ + pull_requests: { + base: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + id: number; + number: number; + url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + */ + status: + | ('requested' | 'in_progress' | 'completed' | 'queued' | null) + | null; + updated_at: Date; + /** + * URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * code_scanning_alert appeared_in_branch event + */ +export type WebhookCodeScanningAlertAppearedInBranch = { + action: 'appeared_in_branch'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: Date; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: Date | null; + /** + * User + */ + dismissed_by: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The reason for dismissing or closing the alert. + */ + dismissed_reason: + | ('false positive' | "won't fix" | 'used in tests' | null) + | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + }; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + tool: { + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + }; + url: string; + }; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + /** + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + ref: string; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * code_scanning_alert closed_by_user event + */ +export type WebhookCodeScanningAlertClosedByUser = { + action: 'closed_by_user'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: Date; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: Date; + /** + * User + */ + dismissed_by: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The reason for dismissing or closing the alert. + */ + dismissed_reason: + | ('false positive' | "won't fix" | 'used in tests' | null) + | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + full_description?: string; + help?: string | null; + /** + * A link to the documentation for the rule used to detect the alert. + */ + help_uri?: string | null; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + name?: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + tags?: string[] | null; + }; + /** + * State of a code scanning alert. + */ + state: 'dismissed' | 'fixed'; + tool: { + guid?: string | null; + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + }; + url: string; + }; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + /** + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + ref: string; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * code_scanning_alert created event + */ +export type WebhookCodeScanningAlertCreated = { + action: 'created'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: Date | null; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: any | null; + dismissed_by: any | null; + dismissed_comment?: CodeScanningAlertDismissedComment; + /** + * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ + dismissed_reason: any | null; + fixed_at?: any | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + full_description?: string; + help?: string | null; + /** + * A link to the documentation for the rule used to detect the alert. + */ + help_uri?: string | null; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + name?: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + tags?: string[] | null; + }; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed'; + tool: { + guid?: string | null; + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + } | null; + updated_at?: string | null; + url: string; + }; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; /** - * @example "2022-04-28T12:00:00Z" + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - archived_at: Date | null; + ref: string; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * branch protection rule created event + * code_scanning_alert fixed event */ -export type WebhookBranchProtectionRuleCreated = { - action: 'created'; - enterprise?: Enterprise; +export type WebhookCodeScanningAlertFixed = { + action: 'fixed'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: Date; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: Date | null; + /** + * User + */ + dismissed_by: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + /** + * The reason for dismissing or closing the alert. + */ + dismissed_reason: + | ('false positive' | "won't fix" | 'used in tests' | null) + | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + full_description?: string; + help?: string | null; + /** + * A link to the documentation for the rule used to detect the alert. + */ + help_uri?: string | null; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + name?: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + tags?: string[] | null; + }; + /** + * State of a code scanning alert. + */ + state: 'fixed'; + tool: { + guid?: string | null; + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + }; + url: string; + }; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; + organization?: OrganizationSimpleWebhooks; /** - * branch protection rule - * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - rule: { - admin_enforced: boolean; - allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; - allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; + ref: string; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * code_scanning_alert reopened event + */ +export type WebhookCodeScanningAlertReopened = { + action: 'reopened'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ created_at: Date; - dismiss_stale_reviews_on_push: boolean; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + dismissed_by: any | null; + /** + * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ + dismissed_reason: string | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + full_description?: string; + help?: string | null; + /** + * A link to the documentation for the rule used to detect the alert. + */ + help_uri?: string | null; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + name?: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + tags?: string[] | null; + }; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + tool: { + guid?: string | null; + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + }; + url: string; + } | null; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string | null; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + /** + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + ref: string | null; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * code_scanning_alert reopened_by_user event + */ +export type WebhookCodeScanningAlertReopenedByUser = { + action: 'reopened_by_user'; + /** + * The code scanning alert involved in the event. + */ + alert: { + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: Date; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: any | null; + dismissed_by: any | null; + /** + * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ + dismissed_reason: any | null; + /** + * The GitHub URL of the alert resource. + */ + html_url: string; + /** + * Alert Instance + */ + most_recent_instance?: { + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + analysis_key: string; + /** + * Identifies the configuration under which the analysis was executed. + */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + ref: string; + /** + * State of a code scanning alert. + */ + state: 'open' | 'dismissed' | 'fixed'; + } | null; + /** + * The code scanning alert number. + */ + number: number; + rule: { + /** + * A short description of the rule used to detect the alert. + */ + description: string; + /** + * A unique identifier for the rule used to detect the alert. + */ + id: string; + /** + * The severity of the alert. + */ + severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + }; + /** + * State of a code scanning alert. + */ + state: 'open' | 'fixed'; + tool: { + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + name: string; + /** + * The version of the tool used to detect the alert. + */ + version: string | null; + }; + url: string; + }; + /** + * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + commit_oid: string; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + /** + * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ + ref: string; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * commit_comment created event + */ +export type WebhookCommitCommentCreated = { + /** + * The action performed. Can be `created`. + */ + action: 'created'; + /** + * The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. + */ + comment: { + /** + * AuthorAssociation + * How the author is associated with the repository. + */ + author_association: + | 'COLLABORATOR' + | 'CONTRIBUTOR' + | 'FIRST_TIMER' + | 'FIRST_TIME_CONTRIBUTOR' + | 'MANNEQUIN' + | 'MEMBER' + | 'NONE' + | 'OWNER'; + /** + * The text of the comment. + */ + body: string; + /** + * The SHA of the commit to which the comment applies. + */ + commit_id: string; + created_at: string; + html_url: string; + /** + * The ID of the commit comment. + */ id: number; - ignore_approvals_from_contributors: boolean; - linear_history_requirement_enforcement_level: - | 'off' - | 'non_admins' - | 'everyone'; - merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; - name: string; - pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; - required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; - required_status_checks: string[]; - required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; - signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; - strict_required_status_checks_policy: boolean; - updated_at: Date; + /** + * The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ + line: number | null; + /** + * The node ID of the commit comment. + */ + node_id: string; + /** + * The relative path of the file to which the comment applies. + */ + path: string | null; + /** + * The line index in the diff to which the comment applies. + */ + position: number | null; + /** + * Reactions + */ + reactions?: { + '+1': number; + '-1': number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + url: string; + }; + updated_at: string; + url: string; + /** + * User + */ + user: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; }; - sender: SimpleUser; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * branch protection rule deleted event + * create event */ -export type WebhookBranchProtectionRuleDeleted = { - action: 'deleted'; - enterprise?: Enterprise; +export type WebhookCreate = { + /** + * The repository's current description. + */ + description: string | null; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; /** - * branch protection rule - * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * The name of the repository's default branch (usually `main`). */ - rule: { - admin_enforced: boolean; - allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; - allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - created_at: Date; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - linear_history_requirement_enforcement_level: - | 'off' - | 'non_admins' - | 'everyone'; - merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; - name: string; - pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; - required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; - required_status_checks: string[]; - required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; - signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; - strict_required_status_checks_policy: boolean; - updated_at: Date; - }; - sender: SimpleUser; -}; -/** - * branch protection rule edited event - */ -export type WebhookBranchProtectionRuleEdited = { - action: 'edited'; + master_branch: string; + organization?: OrganizationSimpleWebhooks; /** - * If the action was `edited`, the changes to the rule. + * The pusher type for the event. Can be either `user` or a deploy key. */ - changes?: { - admin_enforced?: { - from: boolean | null; - }; - authorized_actor_names?: { - from: string[]; - }; - authorized_actors_only?: { - from: boolean | null; - }; - authorized_dismissal_actors_only?: { - from: boolean | null; - }; - linear_history_requirement_enforcement_level?: { - from: 'off' | 'non_admins' | 'everyone'; - }; - required_status_checks?: { - from: string[]; - }; - required_status_checks_enforcement_level?: { - from: 'off' | 'non_admins' | 'everyone'; - }; - }; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; + pusher_type: string; /** - * branch protection rule - * The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - rule: { - admin_enforced: boolean; - allow_deletions_enforcement_level: 'off' | 'non_admins' | 'everyone'; - allow_force_pushes_enforcement_level: 'off' | 'non_admins' | 'everyone'; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - created_at: Date; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - linear_history_requirement_enforcement_level: - | 'off' - | 'non_admins' - | 'everyone'; - merge_queue_enforcement_level: 'off' | 'non_admins' | 'everyone'; - name: string; - pull_request_reviews_enforcement_level: 'off' | 'non_admins' | 'everyone'; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - required_conversation_resolution_level: 'off' | 'non_admins' | 'everyone'; - required_deployments_enforcement_level: 'off' | 'non_admins' | 'everyone'; - required_status_checks: string[]; - required_status_checks_enforcement_level: 'off' | 'non_admins' | 'everyone'; - signature_requirement_enforcement_level: 'off' | 'non_admins' | 'everyone'; - strict_required_status_checks_policy: boolean; - updated_at: Date; - }; - sender: SimpleUser; + ref: string; + /** + * The type of Git ref object created in the repository. + */ + ref_type: 'tag' | 'branch'; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Completed Event + * delete event */ -export type WebhookCheckRunCompleted = { - action?: 'completed'; - check_run: CheckRunWithSimpleCheckSuite; +export type WebhookDelete = { + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * Check Run Completed Event - * The check_run.completed webhook encoded with URL encoding - */ -export type WebhookCheckRunCompletedFormEncoded = { + organization?: OrganizationSimpleWebhooks; /** - * A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. + * The pusher type for the event. Can be either `user` or a deploy key. */ - payload: string; + pusher_type: string; + /** + * The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. + */ + ref: string; + /** + * The type of Git ref object deleted in the repository. + */ + ref_type: 'tag' | 'branch'; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Created Event + * Dependabot alert auto-dismissed event */ -export type WebhookCheckRunCreated = { - action?: 'created'; - check_run: CheckRunWithSimpleCheckSuite; +export type WebhookDependabotAlertAutoDismissed = { + action: 'auto_dismissed'; + alert: DependabotAlert; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Created Event - * The check_run.created webhook encoded with URL encoding + * Dependabot alert auto-reopened event */ -export type WebhookCheckRunCreatedFormEncoded = { - /** - * A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. - */ - payload: string; +export type WebhookDependabotAlertAutoReopened = { + action: 'auto_reopened'; + alert: DependabotAlert; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Requested Action Event + * Dependabot alert created event */ -export type WebhookCheckRunRequestedAction = { - action: 'requested_action'; - check_run: CheckRunWithSimpleCheckSuite; +export type WebhookDependabotAlertCreated = { + action: 'created'; + alert: DependabotAlert; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - /** - * The action requested by the user. - */ - requested_action?: { - /** - * The integrator reference of the action requested by the user. - */ - identifier?: string; - }; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Requested Action Event - * The check_run.requested_action webhook encoded with URL encoding + * Dependabot alert dismissed event */ -export type WebhookCheckRunRequestedActionFormEncoded = { - /** - * A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. - */ - payload: string; +export type WebhookDependabotAlertDismissed = { + action: 'dismissed'; + alert: DependabotAlert; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Re-Requested Event + * Dependabot alert fixed event */ -export type WebhookCheckRunRerequested = { - action?: 'rerequested'; - check_run: CheckRunWithSimpleCheckSuite; +export type WebhookDependabotAlertFixed = { + action: 'fixed'; + alert: DependabotAlert; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * Check Run Re-Requested Event - * The check_run.rerequested webhook encoded with URL encoding + * Dependabot alert reintroduced event */ -export type WebhookCheckRunRerequestedFormEncoded = { - /** - * A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. - */ - payload: string; +export type WebhookDependabotAlertReintroduced = { + action: 'reintroduced'; + alert: DependabotAlert; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * check_suite completed event + * Dependabot alert reopened event */ -export type WebhookCheckSuiteCompleted = { - action: 'completed'; - actions_meta?: any | null; - /** - * The [check_suite](https://docs.github.com/rest/reference/checks#suites). - */ - check_suite: { - after: string | null; - /** - * App - * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - app: { - created_at: Date | null; - description: string | null; - /** - * The list of events for the GitHub app - */ - events?: ( - | 'branch_protection_rule' - | 'check_run' - | 'check_suite' - | 'code_scanning_alert' - | 'commit_comment' - | 'content_reference' - | 'create' - | 'delete' - | 'deployment' - | 'deployment_review' - | 'deployment_status' - | 'deploy_key' - | 'discussion' - | 'discussion_comment' - | 'fork' - | 'gollum' - | 'issues' - | 'issue_comment' - | 'label' - | 'member' - | 'membership' - | 'milestone' - | 'organization' - | 'org_block' - | 'page_build' - | 'project' - | 'project_card' - | 'project_column' - | 'public' - | 'pull_request' - | 'pull_request_review' - | 'pull_request_review_comment' - | 'push' - | 'registry_package' - | 'release' - | 'repository' - | 'repository_dispatch' - | 'secret_scanning_alert' - | 'star' - | 'status' - | 'team' - | 'team_add' - | 'watch' - | 'workflow_dispatch' - | 'workflow_run' - | 'merge_group' - | 'pull_request_review_thread' - | 'workflow_job' - | 'merge_queue_entry' - | 'security_and_analysis' - | 'projects_v2_item' - | 'secret_scanning_alert_location' - )[]; - external_url: string | null; - html_url: string; - /** - * Unique identifier of the GitHub app - */ - id: number | null; - /** - * The name of the GitHub app - */ - name: string; - node_id: string; - /** - * User - */ - owner: { - avatar_url?: string; - deleted?: boolean; - email?: string | null; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: 'Bot' | 'User' | 'Organization'; - url?: string; - } | null; - /** - * The set of permissions for the GitHub app - */ - permissions?: { - actions?: 'read' | 'write'; - administration?: 'read' | 'write'; - checks?: 'read' | 'write'; - content_references?: 'read' | 'write'; - contents?: 'read' | 'write'; - deployments?: 'read' | 'write'; - discussions?: 'read' | 'write'; - emails?: 'read' | 'write'; - environments?: 'read' | 'write'; - issues?: 'read' | 'write'; - keys?: 'read' | 'write'; - members?: 'read' | 'write'; - metadata?: 'read' | 'write'; - organization_administration?: 'read' | 'write'; - organization_hooks?: 'read' | 'write'; - organization_packages?: 'read' | 'write'; - organization_plan?: 'read' | 'write'; - organization_projects?: 'read' | 'write' | 'admin'; - organization_secrets?: 'read' | 'write'; - organization_self_hosted_runners?: 'read' | 'write'; - organization_user_blocking?: 'read' | 'write'; - packages?: 'read' | 'write'; - pages?: 'read' | 'write'; - pull_requests?: 'read' | 'write'; - repository_hooks?: 'read' | 'write'; - repository_projects?: 'read' | 'write' | 'admin'; - secret_scanning_alerts?: 'read' | 'write'; - secrets?: 'read' | 'write'; - security_events?: 'read' | 'write'; - security_scanning_alert?: 'read' | 'write'; - single_file?: 'read' | 'write'; - statuses?: 'read' | 'write'; - team_discussions?: 'read' | 'write'; - vulnerability_alerts?: 'read' | 'write'; - workflows?: 'read' | 'write'; - }; - /** - * The slug name of the GitHub app - */ - slug?: string; - updated_at: Date | null; - }; - before: string | null; - check_runs_url: string; - /** - * The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. - */ - conclusion: - | ( - | 'success' - | 'failure' - | 'neutral' - | 'cancelled' - | 'timed_out' - | 'action_required' - | 'stale' - | null - | 'skipped' - | 'startup_failure' - ) - | null; - created_at: Date; - /** - * The head branch name the changes are on. - */ - head_branch: string | null; - /** - * SimpleCommit - */ - head_commit: { - /** - * Committer - * Metaproperties for Git author/committer information. - */ - author: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; - }; - /** - * Committer - * Metaproperties for Git author/committer information. - */ - committer: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** - * The SHA of the head commit that is being checked. - */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** - * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. - */ - pull_requests: { - base: { - ref: string; - /** - * Repo Ref - */ - repo: { - id: number; - name: string; - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** - * Repo Ref - */ - repo: { - id: number; - name: string; - url: string; - }; - sha: string; - }; - id: number; - number: number; - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - */ - status: - | ( - | 'requested' - | 'in_progress' - | 'completed' - | 'queued' - | null - | 'pending' - ) - | null; - updated_at: Date; - /** - * URL that points to the check suite API resource. - */ +export type WebhookDependabotAlertReopened = { + action: 'reopened'; + alert: DependabotAlert; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + enterprise?: EnterpriseWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * deploy_key created event + */ +export type WebhookDeployKeyCreated = { + action: 'created'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + /** + * The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. + */ + key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; url: string; + verified: boolean; }; - enterprise?: Enterprise; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * deploy_key deleted event + */ +export type WebhookDeployKeyDeleted = { + action: 'deleted'; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + /** + * The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. + */ + key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; + url: string; + verified: boolean; + }; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** - * check_suite requested event + * deployment created event */ -export type WebhookCheckSuiteRequested = { - action: 'requested'; - actions_meta?: any | null; +export type WebhookDeploymentCreated = { + action: 'created'; /** - * The [check_suite](https://docs.github.com/rest/reference/checks#suites). + * Deployment + * The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ - check_suite: { - after: string | null; + deployment: { + created_at: string; + /** + * User + */ + creator: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: any | string; /** * App * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - app: { + performed_via_github_app?: { created_at: Date | null; description: string | null; /** @@ -16450,14 +20514,11 @@ export type WebhookCheckSuiteRequested = { | 'watch' | 'workflow_dispatch' | 'workflow_run' - | 'pull_request_review_thread' | 'workflow_job' + | 'pull_request_review_thread' | 'merge_queue_entry' - | 'security_and_analysis' | 'secret_scanning_alert_location' - | 'projects_v2_item' | 'merge_group' - | 'repository_import' )[]; external_url: string | null; html_url: string; @@ -16517,7 +20578,7 @@ export type WebhookCheckSuiteRequested = { organization_hooks?: 'read' | 'write'; organization_packages?: 'read' | 'write'; organization_plan?: 'read' | 'write'; - organization_projects?: 'read' | 'write' | 'admin'; + organization_projects?: 'read' | 'write'; organization_secrets?: 'read' | 'write'; organization_self_hosted_runners?: 'read' | 'write'; organization_user_blocking?: 'read' | 'write'; @@ -16525,7 +20586,7 @@ export type WebhookCheckSuiteRequested = { pages?: 'read' | 'write'; pull_requests?: 'read' | 'write'; repository_hooks?: 'read' | 'write'; - repository_projects?: 'read' | 'write' | 'admin'; + repository_projects?: 'read' | 'write'; secret_scanning_alerts?: 'read' | 'write'; secrets?: 'read' | 'write'; security_events?: 'read' | 'write'; @@ -16541,12 +20602,72 @@ export type WebhookCheckSuiteRequested = { */ slug?: string; updated_at: Date | null; - }; - before: string | null; - check_runs_url: string; + } | null; + production_environment?: boolean; + ref: string; + repository_url: string; + sha: string; + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; + url: string; + }; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; + /** + * Workflow + */ + workflow: { + badge_url: string; + created_at: Date; + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; + updated_at: Date; + url: string; + } | null; + /** + * Deployment Workflow Run + */ + workflow_run: { /** - * The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * User */ + actor: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; conclusion: | ( | 'success' @@ -16557,211 +20678,58 @@ export type WebhookCheckSuiteRequested = { | 'action_required' | 'stale' | null - | 'skipped' ) | null; created_at: Date; - /** - * The head branch name the changes are on. - */ - head_branch: string | null; - /** - * SimpleCommit - */ - head_commit: { - /** - * Committer - * Metaproperties for Git author/committer information. - */ - author: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; - }; - /** - * Committer - * Metaproperties for Git author/committer information. - */ - committer: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** - * The SHA of the head commit that is being checked. - */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** - * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. - */ - pull_requests: { - base: { - ref: string; - /** - * Repo Ref - */ - repo: { - id: number; - name: string; - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** - * Repo Ref - */ - repo: { - id: number; - name: string; - url: string; - }; - sha: string; - }; - id: number; - number: number; - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - */ - status: - | ('requested' | 'in_progress' | 'completed' | 'queued' | null) - | null; - updated_at: Date; - /** - * URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * check_suite rerequested event - */ -export type WebhookCheckSuiteRerequested = { - action: 'rerequested'; - actions_meta?: { - rerun_info?: { - plan_id?: string; - job_ids?: string[]; - }; - } | null; - /** - * The [check_suite](https://docs.github.com/rest/reference/checks#suites). - */ - check_suite: { - after: string | null; - /** - * App - * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - app: { - created_at: Date | null; - description: string | null; - /** - * The list of events for the GitHub app - */ - events?: ( - | 'branch_protection_rule' - | 'check_run' - | 'check_suite' - | 'code_scanning_alert' - | 'commit_comment' - | 'content_reference' - | 'create' - | 'delete' - | 'deployment' - | 'deployment_review' - | 'deployment_status' - | 'deploy_key' - | 'discussion' - | 'discussion_comment' - | 'fork' - | 'gollum' - | 'issues' - | 'issue_comment' - | 'label' - | 'member' - | 'membership' - | 'milestone' - | 'organization' - | 'org_block' - | 'page_build' - | 'project' - | 'project_card' - | 'project_column' - | 'public' - | 'pull_request' - | 'pull_request_review' - | 'pull_request_review_comment' - | 'push' - | 'registry_package' - | 'release' - | 'repository' - | 'repository_dispatch' - | 'secret_scanning_alert' - | 'star' - | 'status' - | 'team' - | 'team_add' - | 'watch' - | 'workflow_dispatch' - | 'workflow_run' - | 'pull_request_review_thread' - | 'merge_queue_entry' - | 'workflow_job' - )[]; - external_url: string | null; - html_url: string; - /** - * Unique identifier of the GitHub app - */ - id: number | null; - /** - * The name of the GitHub app - */ - name: string; - node_id: string; - /** - * User - */ - owner: { + display_title: string; + event: string; + head_branch: string; + head_commit?: any | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: any | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { avatar_url?: string; - deleted?: boolean; - email?: string | null; events_url?: string; followers_url?: string; following_url?: string; gists_url?: string; gravatar_id?: string; html_url?: string; - id: number; - login: string; - name?: string; + id?: number; + login?: string; node_id?: string; organizations_url?: string; received_events_url?: string; @@ -16769,122 +20737,30 @@ export type WebhookCheckSuiteRerequested = { site_admin?: boolean; starred_url?: string; subscriptions_url?: string; - type?: 'Bot' | 'User' | 'Organization'; + type?: string; url?: string; - } | null; - /** - * The set of permissions for the GitHub app - */ - permissions?: { - actions?: 'read' | 'write'; - administration?: 'read' | 'write'; - checks?: 'read' | 'write'; - content_references?: 'read' | 'write'; - contents?: 'read' | 'write'; - deployments?: 'read' | 'write'; - discussions?: 'read' | 'write'; - emails?: 'read' | 'write'; - environments?: 'read' | 'write'; - issues?: 'read' | 'write'; - keys?: 'read' | 'write'; - members?: 'read' | 'write'; - metadata?: 'read' | 'write'; - organization_administration?: 'read' | 'write'; - organization_hooks?: 'read' | 'write'; - organization_packages?: 'read' | 'write'; - organization_plan?: 'read' | 'write'; - organization_projects?: 'read' | 'write' | 'admin'; - organization_secrets?: 'read' | 'write'; - organization_self_hosted_runners?: 'read' | 'write'; - organization_user_blocking?: 'read' | 'write'; - packages?: 'read' | 'write'; - pages?: 'read' | 'write'; - pull_requests?: 'read' | 'write'; - repository_hooks?: 'read' | 'write'; - repository_projects?: 'read' | 'write' | 'admin'; - secret_scanning_alerts?: 'read' | 'write'; - secrets?: 'read' | 'write'; - security_events?: 'read' | 'write'; - security_scanning_alert?: 'read' | 'write'; - single_file?: 'read' | 'write'; - statuses?: 'read' | 'write'; - team_discussions?: 'read' | 'write'; - vulnerability_alerts?: 'read' | 'write'; - workflows?: 'read' | 'write'; - }; - /** - * The slug name of the GitHub app - */ - slug?: string; - updated_at: Date | null; - }; - before: string | null; - check_runs_url: string; - /** - * The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. - */ - conclusion: - | ( - | 'success' - | 'failure' - | 'neutral' - | 'cancelled' - | 'timed_out' - | 'action_required' - | 'stale' - | null - ) - | null; - created_at: Date; - /** - * The head branch name the changes are on. - */ - head_branch: string | null; - /** - * SimpleCommit - */ - head_commit: { - /** - * Committer - * Metaproperties for Git author/committer information. - */ - author: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; - }; - /** - * Committer - * Metaproperties for Git author/committer information. - */ - committer: { - date?: Date; - email: string | null; - /** - * The git author's name. - */ - name: string; - username?: string; }; - id: string; - message: string; - timestamp: string; - tree_id: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - /** - * The SHA of the head commit that is being checked. - */ head_sha: string; + html_url: string; id: number; - latest_check_runs_count: number; + jobs_url?: string; + logs_url?: string; + name: string; node_id: string; - /** - * An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. - */ + path: string; + previous_attempt_url?: any | null; pull_requests: { base: { ref: string; @@ -16914,47 +20790,95 @@ export type WebhookCheckSuiteRerequested = { number: number; url: string; }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - */ - status: - | ('requested' | 'in_progress' | 'completed' | 'queued' | null) + referenced_workflows?: + | { + path: string; + ref?: string; + sha: string; + }[] | null; - updated_at: Date; - /** - * URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert appeared_in_branch event - */ -export type WebhookCodeScanningAlertAppearedInBranch = { - action: 'appeared_in_branch'; - /** - * The code scanning alert involved in the event. - */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: Date | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: any | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + run_started_at: Date; + status: + | 'requested' + | 'in_progress' + | 'completed' + | 'queued' + | 'waiting' + | 'pending'; /** * User */ - dismissed_by: { + triggering_actor?: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -16977,122 +20901,68 @@ export type WebhookCodeScanningAlertAppearedInBranch = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: - | ('false positive' | "won't fix" | 'used in tests' | null) - | null; - /** - * The GitHub URL of the alert resource. - */ - html_url: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; - }; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - tool: { - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; - }; + updated_at: Date; url: string; - }; + workflow_id: number; + workflow_url?: string; + } | null; +}; +/** + * deployment protection rule requested event + */ +export type WebhookDeploymentProtectionRuleRequested = { + action?: 'requested'; /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + * The name of the environment that has the deployment protection rule. */ - commit_oid: string; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; + environment?: string; /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + * The event that triggered the deployment protection rule. */ - ref: string; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert closed_by_user event - */ -export type WebhookCodeScanningAlertClosedByUser = { - action: 'closed_by_user'; + event?: string; /** - * The code scanning alert involved in the event. + * The URL to review the deployment protection rule. */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: Date; + deployment_callback_url?: string; + deployment?: Deployment; + pull_requests?: PullRequest[]; + repository?: RepositoryWebhooks; + organization?: OrganizationSimpleWebhooks; + installation?: SimpleInstallation; + sender?: SimpleUserWebhooks; +}; +export type WebhookDeploymentReviewApproved = { + action: 'approved'; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + comment?: string; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + reviewers?: { /** * User */ - dismissed_by: { + reviewer?: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -17115,255 +20985,38 @@ export type WebhookCodeScanningAlertClosedByUser = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: - | ('false positive' | "won't fix" | 'used in tests' | null) - | null; - /** - * The GitHub URL of the alert resource. - */ - html_url: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - full_description?: string; - help?: string | null; - /** - * A link to the documentation for the rule used to detect the alert. - */ - help_uri?: string | null; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; - name?: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; - tags?: string[] | null; - }; - /** - * State of a code scanning alert. - */ - state: 'dismissed' | 'fixed'; - tool: { - guid?: string | null; - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; - }; - url: string; - }; - /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - commit_oid: string; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - ref: string; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert created event - */ -export type WebhookCodeScanningAlertCreated = { - action: 'created'; - /** - * The code scanning alert involved in the event. - */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date | null; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: any | null; - dismissed_by: any | null; - dismissed_comment?: CodeScanningAlertDismissedComment; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: any | null; - fixed_at?: any | null; - /** - * The GitHub URL of the alert resource. - */ + type?: 'User'; + }[]; + sender: SimpleUserWebhooks; + since: string; + workflow_job_run?: { + conclusion: any | null; + created_at: string; + environment: string; html_url: string; - instances_url?: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - full_description?: string; - help?: string | null; - /** - * A link to the documentation for the rule used to detect the alert. - */ - help_uri?: string | null; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; - name?: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; - tags?: string[] | null; - }; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed'; - tool: { - guid?: string | null; - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; - } | null; - updated_at?: string | null; - url: string; + id: number; + name: any | null; + status: string; + updated_at: string; }; + workflow_job_runs?: { + conclusion?: any | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - commit_oid: string; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - ref: string; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert fixed event - */ -export type WebhookCodeScanningAlertFixed = { - action: 'fixed'; - /** - * The code scanning alert involved in the event. + * Deployment Workflow Run */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: Date | null; + workflow_run: { /** * User */ - dismissed_by: { + actor: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -17386,418 +21039,336 @@ export type WebhookCodeScanningAlertFixed = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: - | ('false positive' | "won't fix" | 'used in tests' | null) + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + conclusion: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'timed_out' + | 'action_required' + | 'stale' + | null + ) | null; - /** - * The GitHub URL of the alert resource. - */ - html_url: string; - instances_url?: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - full_description?: string; - help?: string | null; - /** - * A link to the documentation for the rule used to detect the alert. - */ - help_uri?: string | null; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; + created_at: Date; + display_title: string; + event: string; + head_branch: string; + head_commit?: any | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; name?: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; - tags?: string[] | null; - }; - /** - * State of a code scanning alert. - */ - state: 'fixed'; - tool: { - guid?: string | null; - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - url: string; - }; - /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - commit_oid: string; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - ref: string; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert reopened event - */ -export type WebhookCodeScanningAlertReopened = { - action: 'reopened'; - /** - * The code scanning alert involved in the event. - */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; - dismissed_by: any | null; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: string | null; - /** - * The GitHub URL of the alert resource. - */ + head_sha: string; html_url: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; }; - message?: { - text?: string; + head: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - full_description?: string; - help?: string | null; - /** - * A link to the documentation for the rule used to detect the alert. - */ - help_uri?: string | null; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; + id: number; + number: number; + url: string; + }[]; + referenced_workflows?: + | { + path: string; + ref?: string; + sha: string; + }[] + | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; name?: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; - tags?: string[] | null; - }; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - tool: { - guid?: string | null; - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; - }; - url: string; - } | null; - /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - commit_oid: string | null; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - ref: string | null; - repository: Repository; - sender: SimpleUser; -}; -/** - * code_scanning_alert reopened_by_user event - */ -export type WebhookCodeScanningAlertReopenedByUser = { - action: 'reopened_by_user'; - /** - * The code scanning alert involved in the event. - */ - alert: { - /** - * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: Date; - /** - * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: any | null; - dismissed_by: any | null; - /** - * The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. - */ - dismissed_reason: any | null; - /** - * The GitHub URL of the alert resource. - */ - html_url: string; - /** - * Alert Instance - */ - most_recent_instance?: { - /** - * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - */ - analysis_key: string; - /** - * Identifies the configuration under which the analysis was executed. - */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** - * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - /** - * The full Git reference, formatted as `refs/heads/`. - */ - ref: string; - /** - * State of a code scanning alert. - */ - state: 'open' | 'dismissed' | 'fixed'; - } | null; - /** - * The code scanning alert number. - */ - number: number; - rule: { - /** - * A short description of the rule used to detect the alert. - */ - description: string; - /** - * A unique identifier for the rule used to detect the alert. - */ - id: string; - /** - * The severity of the alert. - */ - severity: ('none' | 'note' | 'warning' | 'error' | null) | null; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; + rerun_url?: string; + run_attempt: number; + run_number: number; + run_started_at: Date; + status: + | 'requested' + | 'in_progress' + | 'completed' + | 'queued' + | 'waiting' + | 'pending'; /** - * State of a code scanning alert. + * User */ - state: 'open' | 'fixed'; - tool: { - /** - * The name of the tool used to generate the code scanning analysis alert. - */ - name: string; - /** - * The version of the tool used to detect the alert. - */ - version: string | null; - }; + triggering_actor: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + updated_at: Date; url: string; + workflow_id: number; + workflow_url?: string; + } | null; +}; +export type WebhookDeploymentReviewRejected = { + action: 'rejected'; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - /** - * The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - commit_oid: string; - enterprise?: Enterprise; + comment?: string; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. - */ - ref: string; - repository: Repository; - sender: SimpleUser; -}; -/** - * commit_comment created event - */ -export type WebhookCommitCommentCreated = { - /** - * The action performed. Can be `created`. - */ - action: 'created'; - /** - * The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) resource. - */ - comment: { - /** - * AuthorAssociation - * How the author is associated with the repository. - */ - author_association: - | 'COLLABORATOR' - | 'CONTRIBUTOR' - | 'FIRST_TIMER' - | 'FIRST_TIME_CONTRIBUTOR' - | 'MANNEQUIN' - | 'MEMBER' - | 'NONE' - | 'OWNER'; - /** - * The text of the comment. - */ - body: string; + organization: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + reviewers?: { /** - * The SHA of the commit to which the comment applies. + * User */ - commit_id: string; + reviewer?: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + type?: 'User'; + }[]; + sender: SimpleUserWebhooks; + since: string; + workflow_job_run?: { + conclusion: any | null; created_at: string; + environment: string; html_url: string; - /** - * The ID of the commit comment. - */ id: number; - /** - * The line of the blob to which the comment applies. The last line of the range for a multi-line comment - */ - line: number | null; - /** - * The node ID of the commit comment. - */ - node_id: string; - /** - * The relative path of the file to which the comment applies. - */ - path: string | null; - /** - * The line index in the diff to which the comment applies. - */ - position: number | null; - /** - * Reactions - */ - reactions?: { - '+1': number; - '-1': number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; - }; + name: any | null; + status: string; updated_at: string; - url: string; + }; + workflow_job_runs?: { + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; + /** + * Deployment Workflow Run + */ + workflow_run: { /** * User */ - user: { + actor: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -17820,214 +21391,215 @@ export type WebhookCommitCommentCreated = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - }; - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * create event - */ -export type WebhookCreate = { - /** - * The repository's current description. - */ - description: string | null; - enterprise?: Enterprise; - installation?: SimpleInstallation; - /** - * The name of the repository's default branch (usually `main`). - */ - master_branch: string; - organization?: OrganizationSimple; - /** - * The pusher type for the event. Can be either `user` or a deploy key. - */ - pusher_type: string; - /** - * The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource. - */ - ref: string; - /** - * The type of Git ref object created in the repository. - */ - ref_type: 'tag' | 'branch'; - repository: Repository; - sender: SimpleUser; -}; -/** - * delete event - */ -export type WebhookDelete = { - enterprise?: Enterprise; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - /** - * The pusher type for the event. Can be either `user` or a deploy key. - */ - pusher_type: string; - /** - * The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource. - */ - ref: string; - /** - * The type of Git ref object deleted in the repository. - */ - ref_type: 'tag' | 'branch'; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert auto-dismissed event - */ -export type WebhookDependabotAlertAutoDismissed = { - action: 'auto_dismissed'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert auto-reopened event - */ -export type WebhookDependabotAlertAutoReopened = { - action: 'auto_reopened'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert created event - */ -export type WebhookDependabotAlertCreated = { - action: 'created'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert dismissed event - */ -export type WebhookDependabotAlertDismissed = { - action: 'dismissed'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert fixed event - */ -export type WebhookDependabotAlertFixed = { - action: 'fixed'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert reintroduced event - */ -export type WebhookDependabotAlertReintroduced = { - action: 'reintroduced'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * Dependabot alert reopened event - */ -export type WebhookDependabotAlertReopened = { - action: 'reopened'; - alert: DependabotAlert; - installation?: SimpleInstallation; - organization?: OrganizationSimple; - enterprise?: Enterprise; - repository: Repository; - sender: SimpleUser; -}; -/** - * deploy_key created event - */ -export type WebhookDeployKeyCreated = { - action: 'created'; - enterprise?: Enterprise; - installation?: SimpleInstallation; - /** - * The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. - */ - key: { - added_by?: string | null; - created_at: string; - id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * deploy_key deleted event - */ -export type WebhookDeployKeyDeleted = { - action: 'deleted'; - enterprise?: Enterprise; - installation?: SimpleInstallation; - /** - * The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. - */ - key: { - added_by?: string | null; - created_at: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + conclusion: + | ( + | 'success' + | 'failure' + | 'neutral' + | 'cancelled' + | 'timed_out' + | 'action_required' + | 'stale' + | null + ) + | null; + created_at: Date; + event: string; + head_branch: string; + head_commit?: any | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + html_url: string; id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; -}; -/** - * deployment created event - */ -export type WebhookDeploymentCreated = { - action: 'created'; - /** - * Deployment - * The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). - */ - deployment: { - created_at: string; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** + * Repo Ref + */ + repo: { + id: number; + name: string; + url: string; + }; + sha: string; + }; + id: number; + number: number; + url: string; + }[]; + referenced_workflows?: + | { + path: string; + ref?: string; + sha: string; + }[] + | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + run_started_at: Date; + status: 'requested' | 'in_progress' | 'completed' | 'queued' | 'waiting'; /** * User */ - creator: { + triggering_actor: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -18050,187 +21622,87 @@ export type WebhookDeploymentCreated = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - description: string | null; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: any | string; - /** - * App - * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - performed_via_github_app?: { - created_at: Date | null; - description: string | null; - /** - * The list of events for the GitHub app - */ - events?: ( - | 'branch_protection_rule' - | 'check_run' - | 'check_suite' - | 'code_scanning_alert' - | 'commit_comment' - | 'content_reference' - | 'create' - | 'delete' - | 'deployment' - | 'deployment_review' - | 'deployment_status' - | 'deploy_key' - | 'discussion' - | 'discussion_comment' - | 'fork' - | 'gollum' - | 'issues' - | 'issue_comment' - | 'label' - | 'member' - | 'membership' - | 'milestone' - | 'organization' - | 'org_block' - | 'page_build' - | 'project' - | 'project_card' - | 'project_column' - | 'public' - | 'pull_request' - | 'pull_request_review' - | 'pull_request_review_comment' - | 'push' - | 'registry_package' - | 'release' - | 'repository' - | 'repository_dispatch' - | 'secret_scanning_alert' - | 'star' - | 'status' - | 'team' - | 'team_add' - | 'watch' - | 'workflow_dispatch' - | 'workflow_run' - | 'workflow_job' - | 'pull_request_review_thread' - | 'merge_queue_entry' - | 'secret_scanning_alert_location' - | 'merge_group' - )[]; - external_url: string | null; - html_url: string; - /** - * Unique identifier of the GitHub app - */ - id: number | null; - /** - * The name of the GitHub app - */ - name: string; - node_id: string; - /** - * User - */ - owner: { - avatar_url?: string; - deleted?: boolean; - email?: string | null; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: 'Bot' | 'User' | 'Organization'; - url?: string; - } | null; - /** - * The set of permissions for the GitHub app - */ - permissions?: { - actions?: 'read' | 'write'; - administration?: 'read' | 'write'; - checks?: 'read' | 'write'; - content_references?: 'read' | 'write'; - contents?: 'read' | 'write'; - deployments?: 'read' | 'write'; - discussions?: 'read' | 'write'; - emails?: 'read' | 'write'; - environments?: 'read' | 'write'; - issues?: 'read' | 'write'; - keys?: 'read' | 'write'; - members?: 'read' | 'write'; - metadata?: 'read' | 'write'; - organization_administration?: 'read' | 'write'; - organization_hooks?: 'read' | 'write'; - organization_packages?: 'read' | 'write'; - organization_plan?: 'read' | 'write'; - organization_projects?: 'read' | 'write'; - organization_secrets?: 'read' | 'write'; - organization_self_hosted_runners?: 'read' | 'write'; - organization_user_blocking?: 'read' | 'write'; - packages?: 'read' | 'write'; - pages?: 'read' | 'write'; - pull_requests?: 'read' | 'write'; - repository_hooks?: 'read' | 'write'; - repository_projects?: 'read' | 'write'; - secret_scanning_alerts?: 'read' | 'write'; - secrets?: 'read' | 'write'; - security_events?: 'read' | 'write'; - security_scanning_alert?: 'read' | 'write'; - single_file?: 'read' | 'write'; - statuses?: 'read' | 'write'; - team_discussions?: 'read' | 'write'; - vulnerability_alerts?: 'read' | 'write'; - workflows?: 'read' | 'write'; - }; - /** - * The slug name of the GitHub app - */ - slug?: string; - updated_at: Date | null; - } | null; - production_environment?: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment?: boolean; - updated_at: string; + updated_at: Date; url: string; - }; - enterprise?: Enterprise; + workflow_id: number; + workflow_url?: string; + display_title: string; + } | null; +}; +export type WebhookDeploymentReviewRequested = { + action: 'requested'; + enterprise?: EnterpriseWebhooks; + environment: string; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; /** - * Workflow + * User */ - workflow: { - badge_url: string; - created_at: Date; - html_url: string; + requestor: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; id: number; - name: string; - node_id: string; - path: string; - state: string; - updated_at: Date; - url: string; + login: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; } | null; + reviewers: { + /** + * User + */ + reviewer?: { + avatar_url?: string; + deleted?: boolean; + email?: string | null; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id: number; + login?: string; + name?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: 'Bot' | 'User' | 'Organization'; + url?: string; + } | null; + type?: 'User' | 'Team'; + }[]; + sender: SimpleUserWebhooks; + since: string; + workflow_job_run: { + conclusion: any | null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; + }; /** * Deployment Workflow Run */ @@ -18279,7 +21751,6 @@ export type WebhookDeploymentCreated = { ) | null; created_at: Date; - display_title: string; event: string; head_branch: string; head_commit?: any | null; @@ -18295,7 +21766,7 @@ export type WebhookDeploymentCreated = { contents_url?: string; contributors_url?: string; deployments_url?: string; - description?: any | null; + description?: string | null; downloads_url?: string; events_url?: string; fork?: boolean; @@ -18358,7 +21829,7 @@ export type WebhookDeploymentCreated = { name: string; node_id: string; path: string; - previous_attempt_url?: any | null; + previous_attempt_url?: string | null; pull_requests: { base: { ref: string; @@ -18407,7 +21878,7 @@ export type WebhookDeploymentCreated = { contents_url?: string; contributors_url?: string; deployments_url?: string; - description?: any | null; + description?: string | null; downloads_url?: string; events_url?: string; fork?: boolean; @@ -18476,7 +21947,7 @@ export type WebhookDeploymentCreated = { /** * User */ - triggering_actor?: { + triggering_actor: { avatar_url?: string; deleted?: boolean; email?: string | null; @@ -18503,32 +21974,9 @@ export type WebhookDeploymentCreated = { url: string; workflow_id: number; workflow_url?: string; + display_title: string; } | null; }; -/** - * deployment protection rule requested event - */ -export type WebhookDeploymentProtectionRuleRequested = { - action?: 'requested'; - /** - * The name of the environment that has the deployment protection rule. - */ - environment?: string; - /** - * The event that triggered the deployment protection rule. - */ - event?: string; - /** - * The URL to review the deployment protection rule. - */ - deployment_callback_url?: string; - deployment?: Deployment; - pull_requests?: PullRequest[]; - repository?: Repository; - organization?: OrganizationSimple; - installation?: SimpleInstallation; - sender?: SimpleUser; -}; /** * deployment_status created event */ @@ -18537,7 +21985,7 @@ export type WebhookDeploymentStatusCreated = { check_run?: { completed_at: Date | null; /** - * The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * The result of the completed check run. This value will be `null` until the check run has completed. */ conclusion: | ( @@ -18577,7 +22025,7 @@ export type WebhookDeploymentStatusCreated = { } | null; /** * Deployment - * The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + * The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -18769,7 +22217,7 @@ export type WebhookDeploymentStatusCreated = { url: string; }; /** - * The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses). + * The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; @@ -18966,11 +22414,11 @@ export type WebhookDeploymentStatusCreated = { updated_at: string; url: string; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * Workflow */ @@ -19333,11 +22781,11 @@ export type WebhookDiscussionAnswered = { } | null; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion category changed event @@ -19361,11 +22809,11 @@ export type WebhookDiscussionCategoryChanged = { }; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion closed event @@ -19373,11 +22821,11 @@ export type WebhookDiscussionCategoryChanged = { export type WebhookDiscussionClosed = { action: 'closed'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion_comment created event @@ -19451,11 +22899,11 @@ export type WebhookDiscussionCommentCreated = { } | null; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion_comment deleted event @@ -19529,11 +22977,11 @@ export type WebhookDiscussionCommentDeleted = { } | null; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion_comment edited event @@ -19612,11 +23060,11 @@ export type WebhookDiscussionCommentEdited = { } | null; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion created event @@ -19796,11 +23244,11 @@ export type WebhookDiscussionCreated = { url?: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion deleted event @@ -19808,11 +23256,11 @@ export type WebhookDiscussionCreated = { export type WebhookDiscussionDeleted = { action: 'deleted'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion edited event @@ -19828,11 +23276,11 @@ export type WebhookDiscussionEdited = { }; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion labeled event @@ -19840,7 +23288,7 @@ export type WebhookDiscussionEdited = { export type WebhookDiscussionLabeled = { action: 'labeled'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -19863,9 +23311,9 @@ export type WebhookDiscussionLabeled = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion locked event @@ -19873,11 +23321,11 @@ export type WebhookDiscussionLabeled = { export type WebhookDiscussionLocked = { action: 'locked'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion pinned event @@ -19885,11 +23333,11 @@ export type WebhookDiscussionLocked = { export type WebhookDiscussionPinned = { action: 'pinned'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion reopened event @@ -19897,11 +23345,11 @@ export type WebhookDiscussionPinned = { export type WebhookDiscussionReopened = { action: 'reopened'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion transferred event @@ -19910,14 +23358,14 @@ export type WebhookDiscussionTransferred = { action: 'transferred'; changes: { new_discussion: Discussion; - new_repository: Repository; + new_repository: RepositoryWebhooks; }; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion unanswered event @@ -19991,9 +23439,9 @@ export type WebhookDiscussionUnanswered = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * discussion unlabeled event @@ -20001,7 +23449,7 @@ export type WebhookDiscussionUnanswered = { export type WebhookDiscussionUnlabeled = { action: 'unlabeled'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -20024,9 +23472,9 @@ export type WebhookDiscussionUnlabeled = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion unlocked event @@ -20034,11 +23482,11 @@ export type WebhookDiscussionUnlabeled = { export type WebhookDiscussionUnlocked = { action: 'unlocked'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * discussion unpinned event @@ -20046,20 +23494,20 @@ export type WebhookDiscussionUnlocked = { export type WebhookDiscussionUnpinned = { action: 'unpinned'; discussion: Discussion; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * fork event * A user forks a repository. */ export type WebhookFork = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; /** - * The created [`repository`](https://docs.github.com/rest/reference/repos#get-a-repository) resource. + * The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ forkee: { /** @@ -20350,28 +23798,28 @@ export type WebhookFork = { watchers_count?: number; }; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * github_app_authorization revoked event */ export type WebhookGithubAppAuthorizationRevoked = { action: 'revoked'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * gollum event */ export type WebhookGollum = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * The pages that were updated. */ @@ -20398,17 +23846,17 @@ export type WebhookGollum = { */ title: string; }[]; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * installation created event */ export type WebhookInstallationCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects that the installation can access. */ @@ -20428,7 +23876,7 @@ export type WebhookInstallationCreated = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; /** * User */ @@ -20455,16 +23903,16 @@ export type WebhookInstallationCreated = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * installation deleted event */ export type WebhookInstallationDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects that the installation can access. */ @@ -20484,18 +23932,18 @@ export type WebhookInstallationDeleted = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; requester?: any | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * installation new_permissions_accepted event */ export type WebhookInstallationNewPermissionsAccepted = { action: 'new_permissions_accepted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects that the installation can access. */ @@ -20515,18 +23963,18 @@ export type WebhookInstallationNewPermissionsAccepted = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; requester?: any | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * installation_repositories added event */ export type WebhookInstallationRepositoriesAdded = { action: 'added'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects, which were added to the installation. */ @@ -20565,7 +24013,7 @@ export type WebhookInstallationRepositoriesAdded = { */ private?: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; /** * Describe whether all repositories have been selected or there's a selection involved */ @@ -20596,16 +24044,16 @@ export type WebhookInstallationRepositoriesAdded = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * installation_repositories removed event */ export type WebhookInstallationRepositoriesRemoved = { action: 'removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects, which were added to the installation. */ @@ -20644,7 +24092,7 @@ export type WebhookInstallationRepositoriesRemoved = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; /** * Describe whether all repositories have been selected or there's a selection involved */ @@ -20675,16 +24123,16 @@ export type WebhookInstallationRepositoriesRemoved = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * installation suspend event */ export type WebhookInstallationSuspend = { action: 'suspend'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects that the installation can access. */ @@ -20704,12 +24152,13 @@ export type WebhookInstallationSuspend = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; requester?: any | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; export type WebhookInstallationTargetRenamed = { account: { + archived_at?: string | null; avatar_url: string; created_at?: string; description?: any | null; @@ -20746,7 +24195,7 @@ export type WebhookInstallationTargetRenamed = { url?: string; website_url?: any | null; }; - action: string; + action: 'renamed'; changes: { login?: { from: string; @@ -20755,11 +24204,11 @@ export type WebhookInstallationTargetRenamed = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; target_type: string; }; /** @@ -20767,9 +24216,9 @@ export type WebhookInstallationTargetRenamed = { */ export type WebhookInstallationUnsuspend = { action: 'unsuspend'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: Installation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * An array of repository objects that the installation can access. */ @@ -20789,9 +24238,9 @@ export type WebhookInstallationUnsuspend = { */ private: boolean; }[]; - repository?: Repository; + repository?: RepositoryWebhooks; requester?: any | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * issue_comment created event @@ -20800,7 +24249,7 @@ export type WebhookIssueCommentCreated = { action: 'created'; /** * issue comment - * The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -20876,10 +24325,10 @@ export type WebhookIssueCommentCreated = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** - * The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { active_lock_reason: @@ -21347,9 +24796,9 @@ export type WebhookIssueCommentCreated = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issue_comment deleted event @@ -21358,7 +24807,7 @@ export type WebhookIssueCommentDeleted = { action: 'deleted'; /** * issue comment - * The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -21434,10 +24883,10 @@ export type WebhookIssueCommentDeleted = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** - * The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { active_lock_reason: @@ -21903,9 +25352,9 @@ export type WebhookIssueCommentDeleted = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issue_comment edited event @@ -21925,7 +25374,7 @@ export type WebhookIssueCommentEdited = { }; /** * issue comment - * The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -22001,10 +25450,10 @@ export type WebhookIssueCommentEdited = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** - * The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { active_lock_reason: @@ -22472,9 +25921,9 @@ export type WebhookIssueCommentEdited = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues assigned event @@ -22510,11 +25959,11 @@ export type WebhookIssuesAssigned = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -22879,9 +26328,9 @@ export type WebhookIssuesAssigned = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues closed event @@ -22891,10 +26340,10 @@ export type WebhookIssuesClosed = { * The action that was performed. */ action: 'closed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -23318,20 +26767,20 @@ export type WebhookIssuesClosed = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues deleted event */ export type WebhookIssuesDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -23695,16 +27144,16 @@ export type WebhookIssuesDeleted = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues demilestoned event */ export type WebhookIssuesDemilestoned = { action: 'demilestoned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; issue: { active_lock_reason: @@ -24236,9 +27685,9 @@ export type WebhookIssuesDemilestoned = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues edited event @@ -24262,11 +27711,11 @@ export type WebhookIssuesEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -24653,20 +28102,20 @@ export type WebhookIssuesEdited = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues labeled event */ export type WebhookIssuesLabeled = { action: 'labeled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -25052,16 +28501,16 @@ export type WebhookIssuesLabeled = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues locked event */ export type WebhookIssuesLocked = { action: 'locked'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; issue: { active_lock_reason: @@ -25486,16 +28935,16 @@ export type WebhookIssuesLocked = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues milestoned event */ export type WebhookIssuesMilestoned = { action: 'milestoned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; issue: { active_lock_reason: @@ -26028,9 +29477,9 @@ export type WebhookIssuesMilestoned = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues opened event @@ -26040,7 +29489,7 @@ export type WebhookIssuesOpened = { changes?: { /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: { active_lock_reason: @@ -26473,6 +29922,10 @@ export type WebhookIssuesOpened = { git_refs_url: string; git_tags_url: string; git_url: string; + /** + * Whether the repository has discussions enabled. + */ + has_discussions?: boolean; /** * Whether downloads are enabled. * @defaultValue true @@ -26592,13 +30045,17 @@ export type WebhookIssuesOpened = { visibility: 'public' | 'private' | 'internal'; watchers: number; watchers_count: number; + /** + * Whether to require commit signoff. + */ + web_commit_signoff_required?: boolean; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -26964,20 +30421,20 @@ export type WebhookIssuesOpened = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues pinned event */ export type WebhookIssuesPinned = { action: 'pinned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -27340,16 +30797,16 @@ export type WebhookIssuesPinned = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues reopened event */ export type WebhookIssuesReopened = { action: 'reopened'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; issue: { active_lock_reason: @@ -27772,9 +31229,9 @@ export type WebhookIssuesReopened = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues transferred event @@ -27784,7 +31241,7 @@ export type WebhookIssuesTransferred = { changes: { /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { active_lock_reason: @@ -28346,11 +31803,11 @@ export type WebhookIssuesTransferred = { web_commit_signoff_required?: boolean; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -28713,9 +32170,9 @@ export type WebhookIssuesTransferred = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues unassigned event @@ -28751,11 +32208,11 @@ export type WebhookIssuesUnassigned = { type?: 'Bot' | 'User' | 'Organization' | 'Mannequin'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -29120,20 +32577,20 @@ export type WebhookIssuesUnassigned = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues unlabeled event */ export type WebhookIssuesUnlabeled = { action: 'unlabeled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -29519,16 +32976,16 @@ export type WebhookIssuesUnlabeled = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues unlocked event */ export type WebhookIssuesUnlocked = { action: 'unlocked'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; issue: { active_lock_reason: @@ -29949,20 +33406,20 @@ export type WebhookIssuesUnlocked = { url?: string; }; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * issues unpinned event */ export type WebhookIssuesUnpinned = { action: 'unpinned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Issue - * The [issue](https://docs.github.com/rest/reference/issues) itself. + * The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { active_lock_reason: @@ -30325,16 +33782,16 @@ export type WebhookIssuesUnpinned = { url?: string; } | null; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * label created event */ export type WebhookLabelCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -30357,16 +33814,16 @@ export type WebhookLabelCreated = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * label deleted event */ export type WebhookLabelDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -30389,9 +33846,9 @@ export type WebhookLabelDeleted = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * label edited event @@ -30421,7 +33878,7 @@ export type WebhookLabelEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -30444,9 +33901,9 @@ export type WebhookLabelEdited = { */ url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * marketplace_purchase cancelled event @@ -30454,7 +33911,7 @@ export type WebhookLabelEdited = { export type WebhookMarketplacePurchaseCancelled = { action: 'cancelled'; effective_date: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; marketplace_purchase: { account: { @@ -30505,7 +33962,7 @@ export type WebhookMarketplacePurchaseCancelled = { }; unit_count?: number; }; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Marketplace Purchase */ @@ -30534,8 +33991,8 @@ export type WebhookMarketplacePurchaseCancelled = { }; unit_count: number; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * marketplace_purchase changed event @@ -30543,7 +34000,7 @@ export type WebhookMarketplacePurchaseCancelled = { export type WebhookMarketplacePurchaseChanged = { action: 'changed'; effective_date: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; marketplace_purchase: { account: { @@ -30594,7 +34051,7 @@ export type WebhookMarketplacePurchaseChanged = { }; unit_count?: number; }; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Marketplace Purchase */ @@ -30623,8 +34080,8 @@ export type WebhookMarketplacePurchaseChanged = { }; unit_count: number; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * marketplace_purchase pending_change event @@ -30632,7 +34089,7 @@ export type WebhookMarketplacePurchaseChanged = { export type WebhookMarketplacePurchasePendingChange = { action: 'pending_change'; effective_date: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; marketplace_purchase: { account: { @@ -30683,7 +34140,7 @@ export type WebhookMarketplacePurchasePendingChange = { }; unit_count?: number; }; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Marketplace Purchase */ @@ -30712,8 +34169,8 @@ export type WebhookMarketplacePurchasePendingChange = { }; unit_count: number; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * marketplace_purchase pending_change_cancelled event @@ -30721,7 +34178,7 @@ export type WebhookMarketplacePurchasePendingChange = { export type WebhookMarketplacePurchasePendingChangeCancelled = { action: 'pending_change_cancelled'; effective_date: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; marketplace_purchase: { account: { @@ -30750,7 +34207,7 @@ export type WebhookMarketplacePurchasePendingChangeCancelled = { } & { next_billing_date: string; }; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Marketplace Purchase */ @@ -30779,8 +34236,8 @@ export type WebhookMarketplacePurchasePendingChangeCancelled = { }; unit_count: number; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * marketplace_purchase purchased event @@ -30788,7 +34245,7 @@ export type WebhookMarketplacePurchasePendingChangeCancelled = { export type WebhookMarketplacePurchasePurchased = { action: 'purchased'; effective_date: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; marketplace_purchase: { account: { @@ -30839,7 +34296,7 @@ export type WebhookMarketplacePurchasePurchased = { }; unit_count?: number; }; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Marketplace Purchase */ @@ -30868,8 +34325,8 @@ export type WebhookMarketplacePurchasePurchased = { }; unit_count: number; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * member added event @@ -30881,7 +34338,7 @@ export type WebhookMemberAdded = { to: 'write' | 'admin' | 'read'; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * User @@ -30909,9 +34366,9 @@ export type WebhookMemberAdded = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * member edited event @@ -30933,7 +34390,7 @@ export type WebhookMemberEdited = { to?: string | null; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * User @@ -30961,16 +34418,16 @@ export type WebhookMemberEdited = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * member removed event */ export type WebhookMemberRemoved = { action: 'removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * User @@ -30998,16 +34455,16 @@ export type WebhookMemberRemoved = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * membership added event */ export type WebhookMembershipAdded = { action: 'added'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * User @@ -31035,8 +34492,8 @@ export type WebhookMembershipAdded = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - organization: OrganizationSimple; - repository?: Repository; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; /** * The scope of the membership. Currently, can only be `team`. */ @@ -31139,7 +34596,7 @@ export type WebhookMembershipAdded = { */ export type WebhookMembershipRemoved = { action: 'removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * User @@ -31167,8 +34624,8 @@ export type WebhookMembershipRemoved = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - organization: OrganizationSimple; - repository?: Repository; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; /** * The scope of the membership. Currently, can only be `team`. */ @@ -31270,9 +34727,9 @@ export type WebhookMergeGroupChecksRequested = { action: 'checks_requested'; installation?: SimpleInstallation; merge_group: MergeGroup; - organization?: OrganizationSimple; - repository?: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; export type WebhookMergeGroupDestroyed = { action: 'destroyed'; @@ -31282,16 +34739,16 @@ export type WebhookMergeGroupDestroyed = { reason?: 'merged' | 'invalidated' | 'dequeued'; installation?: SimpleInstallation; merge_group: MergeGroup; - organization?: OrganizationSimple; - repository?: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * meta deleted event */ export type WebhookMetaDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; /** * The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ @@ -31368,16 +34825,16 @@ export type WebhookMetaDeleted = { */ hook_id: number; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: NullableRepository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: NullableRepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * milestone closed event */ export type WebhookMilestoneClosed = { action: 'closed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Milestone @@ -31435,16 +34892,16 @@ export type WebhookMilestoneClosed = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * milestone created event */ export type WebhookMilestoneCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Milestone @@ -31502,16 +34959,16 @@ export type WebhookMilestoneCreated = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * milestone deleted event */ export type WebhookMilestoneDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Milestone @@ -31569,9 +35026,9 @@ export type WebhookMilestoneDeleted = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * milestone edited event @@ -31601,7 +35058,7 @@ export type WebhookMilestoneEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Milestone @@ -31659,16 +35116,16 @@ export type WebhookMilestoneEdited = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * milestone opened event */ export type WebhookMilestoneOpened = { action: 'opened'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Milestone @@ -31726,9 +35183,9 @@ export type WebhookMilestoneOpened = { updated_at: Date; url: string; }; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * org_block blocked event @@ -31761,11 +35218,11 @@ export type WebhookOrgBlockBlocked = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * org_block unblocked event @@ -31798,18 +35255,18 @@ export type WebhookOrgBlockUnblocked = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * organization deleted event */ export type WebhookOrganizationDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Membership @@ -31847,16 +35304,16 @@ export type WebhookOrganizationDeleted = { url?: string; } | null; }; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * organization member_added event */ export type WebhookOrganizationMemberAdded = { action: 'member_added'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Membership @@ -31894,16 +35351,16 @@ export type WebhookOrganizationMemberAdded = { url?: string; } | null; }; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * organization member_invited event */ export type WebhookOrganizationMemberInvited = { action: 'member_invited'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The invitation for the user or email if the action is `member_invited`. @@ -31947,9 +35404,9 @@ export type WebhookOrganizationMemberInvited = { team_count: number; invitation_source?: string; }; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * User */ @@ -31982,7 +35439,7 @@ export type WebhookOrganizationMemberInvited = { */ export type WebhookOrganizationMemberRemoved = { action: 'member_removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Membership @@ -32020,9 +35477,9 @@ export type WebhookOrganizationMemberRemoved = { url?: string; } | null; }; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * organization renamed event @@ -32034,7 +35491,7 @@ export type WebhookOrganizationRenamed = { from?: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Membership @@ -32072,9 +35529,9 @@ export type WebhookOrganizationRenamed = { url?: string; } | null; }; - organization: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * Ruby Gems metadata @@ -32102,9 +35559,9 @@ export type WebhookRubygemsMetadata = { */ export type WebhookPackagePublished = { action: 'published'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Information about the package. */ @@ -32320,17 +35777,17 @@ export type WebhookPackagePublished = { } | null; updated_at: string | null; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * package updated event */ export type WebhookPackageUpdated = { action: 'updated'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Information about the package. */ @@ -32483,15 +35940,15 @@ export type WebhookPackageUpdated = { } | null; updated_at: string; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * page_build event */ export type WebhookPageBuild = { /** - * The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) itself. + * The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; @@ -32530,12 +35987,12 @@ export type WebhookPageBuild = { updated_at: string; url: string; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; id: number; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * personal_access_token_request approved event @@ -32543,8 +36000,8 @@ export type WebhookPageBuild = { export type WebhookPersonalAccessTokenRequestApproved = { action: 'approved'; personal_access_token_request: PersonalAccessTokenRequest; - organization: OrganizationSimple; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + sender: SimpleUserWebhooks; installation: SimpleInstallation; }; /** @@ -32553,8 +36010,8 @@ export type WebhookPersonalAccessTokenRequestApproved = { export type WebhookPersonalAccessTokenRequestCancelled = { action: 'cancelled'; personal_access_token_request: PersonalAccessTokenRequest; - organization: OrganizationSimple; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + sender: SimpleUserWebhooks; installation: SimpleInstallation; }; /** @@ -32563,8 +36020,8 @@ export type WebhookPersonalAccessTokenRequestCancelled = { export type WebhookPersonalAccessTokenRequestCreated = { action: 'created'; personal_access_token_request: PersonalAccessTokenRequest; - organization: OrganizationSimple; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + sender: SimpleUserWebhooks; installation: SimpleInstallation; }; /** @@ -32573,8 +36030,8 @@ export type WebhookPersonalAccessTokenRequestCreated = { export type WebhookPersonalAccessTokenRequestDenied = { action: 'denied'; personal_access_token_request: PersonalAccessTokenRequest; - organization: OrganizationSimple; - sender: SimpleUser; + organization: OrganizationSimpleWebhooks; + sender: SimpleUserWebhooks; installation: SimpleInstallation; }; export type WebhookPing = { @@ -32622,9 +36079,9 @@ export type WebhookPing = { * The ID of the webhook that triggered the ping. */ hook_id?: number; - organization?: OrganizationSimple; - repository?: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; /** * Random string of GitHub zen. */ @@ -32649,9 +36106,9 @@ export type WebhookProjectCardConverted = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Card */ @@ -32701,17 +36158,17 @@ export type WebhookProjectCardConverted = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project_card created event */ export type WebhookProjectCardCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Card */ @@ -32761,17 +36218,17 @@ export type WebhookProjectCardCreated = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project_card deleted event */ export type WebhookProjectCardDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Card */ @@ -32821,8 +36278,8 @@ export type WebhookProjectCardDeleted = { updated_at: Date; url: string; }; - repository?: NullableRepository; - sender: SimpleUser; + repository?: NullableRepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project_card edited event @@ -32834,9 +36291,9 @@ export type WebhookProjectCardEdited = { from: string | null; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Card */ @@ -32886,8 +36343,8 @@ export type WebhookProjectCardEdited = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project_card moved event @@ -32899,9 +36356,9 @@ export type WebhookProjectCardMoved = { from: number; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; project_card: { after_id?: number | null; /** @@ -32980,17 +36437,17 @@ export type WebhookProjectCardMoved = { updated_at?: string; url?: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project closed event */ export type WebhookProjectClosed = { action: 'closed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project */ @@ -33043,17 +36500,17 @@ export type WebhookProjectClosed = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project_column created event */ export type WebhookProjectColumnCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Column */ @@ -33074,17 +36531,17 @@ export type WebhookProjectColumnCreated = { updated_at: Date; url: string; }; - repository?: Repository; - sender?: SimpleUser; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * project_column deleted event */ export type WebhookProjectColumnDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Column */ @@ -33105,8 +36562,8 @@ export type WebhookProjectColumnDeleted = { updated_at: Date; url: string; }; - repository?: NullableRepository; - sender?: SimpleUser; + repository?: NullableRepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * project_column edited event @@ -33118,9 +36575,9 @@ export type WebhookProjectColumnEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Column */ @@ -33141,17 +36598,17 @@ export type WebhookProjectColumnEdited = { updated_at: Date; url: string; }; - repository?: Repository; - sender?: SimpleUser; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * project_column moved event */ export type WebhookProjectColumnMoved = { action: 'moved'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project Column */ @@ -33172,17 +36629,17 @@ export type WebhookProjectColumnMoved = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project created event */ export type WebhookProjectCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project */ @@ -33235,17 +36692,17 @@ export type WebhookProjectCreated = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * project deleted event */ export type WebhookProjectDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project */ @@ -33298,8 +36755,8 @@ export type WebhookProjectDeleted = { updated_at: Date; url: string; }; - repository?: NullableRepository; - sender?: SimpleUser; + repository?: NullableRepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * project edited event @@ -33323,9 +36780,9 @@ export type WebhookProjectEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project */ @@ -33378,17 +36835,17 @@ export type WebhookProjectEdited = { updated_at: Date; url: string; }; - repository?: Repository; - sender?: SimpleUser; + repository?: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * project reopened event */ export type WebhookProjectReopened = { action: 'reopened'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Project */ @@ -33441,8 +36898,8 @@ export type WebhookProjectReopened = { updated_at: Date; url: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * Projects v2 Project Closed Event @@ -33450,9 +36907,9 @@ export type WebhookProjectReopened = { export type WebhookProjectsV2ProjectClosed = { action: 'closed'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2: ProjectsV2; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * A project was created @@ -33460,9 +36917,9 @@ export type WebhookProjectsV2ProjectClosed = { export type WebhookProjectsV2ProjectCreated = { action: 'created'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2: ProjectsV2; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Project Deleted Event @@ -33470,9 +36927,9 @@ export type WebhookProjectsV2ProjectCreated = { export type WebhookProjectsV2ProjectDeleted = { action: 'deleted'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2: ProjectsV2; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Project Edited Event @@ -33498,9 +36955,9 @@ export type WebhookProjectsV2ProjectEdited = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2: ProjectsV2; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Archived Event @@ -33514,9 +36971,9 @@ export type WebhookProjectsV2ItemArchived = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Converted Event @@ -33530,9 +36987,9 @@ export type WebhookProjectsV2ItemConverted = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Created Event @@ -33540,9 +36997,9 @@ export type WebhookProjectsV2ItemConverted = { export type WebhookProjectsV2ItemCreated = { action: 'created'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Deleted Event @@ -33550,9 +37007,9 @@ export type WebhookProjectsV2ItemCreated = { export type WebhookProjectsV2ItemDeleted = { action: 'deleted'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Edited Event @@ -33573,9 +37030,9 @@ export type WebhookProjectsV2ItemEdited = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Reordered Event @@ -33589,9 +37046,9 @@ export type WebhookProjectsV2ItemReordered = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Item Restored Event @@ -33605,9 +37062,9 @@ export type WebhookProjectsV2ItemRestored = { }; }; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2_item: ProjectsV2Item; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * Projects v2 Project Reopened Event @@ -33615,19 +37072,19 @@ export type WebhookProjectsV2ItemRestored = { export type WebhookProjectsV2ProjectReopened = { action: 'reopened'; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; projects_v2: ProjectsV2; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * public event */ export type WebhookPublic = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request assigned event @@ -33660,13 +37117,13 @@ export type WebhookPullRequestAssigned = { type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -34671,18 +38128,18 @@ export type WebhookPullRequestAssigned = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request auto_merge_disabled event */ export type WebhookPullRequestAutoMergeDisabled = { action: 'auto_merge_disabled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -35688,18 +39145,18 @@ export type WebhookPullRequestAutoMergeDisabled = { } | null; }; reason: string; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request auto_merge_enabled event */ export type WebhookPullRequestAutoMergeEnabled = { action: 'auto_merge_enabled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -36705,21 +40162,21 @@ export type WebhookPullRequestAutoMergeEnabled = { } | null; }; reason?: string; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request closed event */ export type WebhookPullRequestClosed = { action: 'closed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -36764,21 +40221,21 @@ export type WebhookPullRequestClosed = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request converted_to_draft event */ export type WebhookPullRequestConvertedToDraft = { action: 'converted_to_draft'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -36823,21 +40280,21 @@ export type WebhookPullRequestConvertedToDraft = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request demilestoned event */ export type WebhookPullRequestDemilestoned = { action: 'demilestoned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; milestone?: Milestone; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -37842,18 +41299,18 @@ export type WebhookPullRequestDemilestoned = { url?: string; } | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * pull_request dequeued event */ export type WebhookPullRequestDequeued = { action: 'dequeued'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -38859,8 +42316,8 @@ export type WebhookPullRequestDequeued = { } | null; }; reason: string; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request edited event @@ -38892,13 +42349,13 @@ export type WebhookPullRequestEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -38943,18 +42400,18 @@ export type WebhookPullRequestEdited = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * pull_request enqueued event */ export type WebhookPullRequestEnqueued = { action: 'enqueued'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -39959,15 +43416,15 @@ export type WebhookPullRequestEnqueued = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request labeled event */ export type WebhookPullRequestLabeled = { action: 'labeled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -39994,7 +43451,7 @@ export type WebhookPullRequestLabeled = { * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -40999,21 +44456,21 @@ export type WebhookPullRequestLabeled = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request locked event */ export type WebhookPullRequestLocked = { action: 'locked'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -42018,21 +45475,21 @@ export type WebhookPullRequestLocked = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request milestoned event */ export type WebhookPullRequestMilestoned = { action: 'milestoned'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; milestone?: Milestone; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -43037,21 +46494,21 @@ export type WebhookPullRequestMilestoned = { url?: string; } | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * pull_request opened event */ export type WebhookPullRequestOpened = { action: 'opened'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -43096,21 +46553,21 @@ export type WebhookPullRequestOpened = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request ready_for_review event */ export type WebhookPullRequestReadyForReview = { action: 'ready_for_review'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -43155,21 +46612,21 @@ export type WebhookPullRequestReadyForReview = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request reopened event */ export type WebhookPullRequestReopened = { action: 'reopened'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: PullRequest & { /** * Whether to allow auto-merge for pull requests. @@ -43214,8 +46671,8 @@ export type WebhookPullRequestReopened = { */ use_squash_pr_title_as_default?: boolean; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request_review_comment created event @@ -43224,7 +46681,7 @@ export type WebhookPullRequestReviewCommentCreated = { action: 'created'; /** * Pull Request Review Comment - * The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -43389,9 +46846,9 @@ export type WebhookPullRequestReviewCommentCreated = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: { _links: { /** @@ -44341,8 +47798,8 @@ export type WebhookPullRequestReviewCommentCreated = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request_review_comment deleted event @@ -44351,7 +47808,7 @@ export type WebhookPullRequestReviewCommentDeleted = { action: 'deleted'; /** * Pull Request Review Comment - * The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -44516,9 +47973,9 @@ export type WebhookPullRequestReviewCommentDeleted = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: { _links: { /** @@ -45468,8 +48925,8 @@ export type WebhookPullRequestReviewCommentDeleted = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request_review_comment edited event @@ -45489,7 +48946,7 @@ export type WebhookPullRequestReviewCommentEdited = { }; /** * Pull Request Review Comment - * The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -45654,9 +49111,9 @@ export type WebhookPullRequestReviewCommentEdited = { url?: string; } | null; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; pull_request: { _links: { /** @@ -46606,17 +50063,17 @@ export type WebhookPullRequestReviewCommentEdited = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request_review dismissed event */ export type WebhookPullRequestReviewDismissed = { action: 'dismissed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Simple Pull Request */ @@ -47569,7 +51026,7 @@ export type WebhookPullRequestReviewDismissed = { url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * The review that was affected. */ @@ -47645,7 +51102,7 @@ export type WebhookPullRequestReviewDismissed = { url?: string; } | null; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * pull_request_review edited event @@ -47660,9 +51117,9 @@ export type WebhookPullRequestReviewEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Simple Pull Request */ @@ -48531,7 +51988,7 @@ export type WebhookPullRequestReviewEdited = { url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * The review that was affected. */ @@ -48607,7 +52064,7 @@ export type WebhookPullRequestReviewEdited = { url?: string; } | null; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * pull_request review_request_removed event @@ -48615,13 +52072,13 @@ export type WebhookPullRequestReviewEdited = { export type WebhookPullRequestReviewRequestRemoved = | { action: 'review_request_removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -49625,7 +53082,7 @@ export type WebhookPullRequestReviewRequestRemoved = url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * User */ @@ -49652,17 +53109,17 @@ export type WebhookPullRequestReviewRequestRemoved = type?: 'Bot' | 'User' | 'Organization'; url?: string; } | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; } | { action: 'review_request_removed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -50673,7 +54130,7 @@ export type WebhookPullRequestReviewRequestRemoved = url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -50735,7 +54192,7 @@ export type WebhookPullRequestReviewRequestRemoved = */ url: string; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * pull_request review_requested event @@ -50743,13 +54200,13 @@ export type WebhookPullRequestReviewRequestRemoved = export type WebhookPullRequestReviewRequested = | { action: 'review_requested'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -51760,7 +55217,7 @@ export type WebhookPullRequestReviewRequested = url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * User */ @@ -51787,17 +55244,17 @@ export type WebhookPullRequestReviewRequested = type?: 'Bot' | 'User' | 'Organization' | 'Mannequin'; url?: string; } | null; - sender: SimpleUser; + sender: SimpleUserWebhooks; } | { action: 'review_requested'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -52808,7 +56265,7 @@ export type WebhookPullRequestReviewRequested = url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -52870,16 +56327,16 @@ export type WebhookPullRequestReviewRequested = */ url?: string; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * pull_request_review submitted event */ export type WebhookPullRequestReviewSubmitted = { action: 'submitted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Simple Pull Request */ @@ -53832,7 +57289,7 @@ export type WebhookPullRequestReviewSubmitted = { url?: string; } | null; }; - repository: Repository; + repository: RepositoryWebhooks; /** * The review that was affected. */ @@ -53908,16 +57365,16 @@ export type WebhookPullRequestReviewSubmitted = { url?: string; } | null; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; }; /** * pull_request_review_thread resolved event */ export type WebhookPullRequestReviewThreadResolved = { action: 'resolved'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Simple Pull Request */ @@ -54802,8 +58259,8 @@ export type WebhookPullRequestReviewThreadResolved = { url?: string; } | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; thread: { comments: { _links: { @@ -54976,9 +58433,9 @@ export type WebhookPullRequestReviewThreadResolved = { */ export type WebhookPullRequestReviewThreadUnresolved = { action: 'unresolved'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Simple Pull Request */ @@ -55863,8 +59320,8 @@ export type WebhookPullRequestReviewThreadUnresolved = { url?: string; } | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; thread: { comments: { _links: { @@ -56039,13 +59496,13 @@ export type WebhookPullRequestSynchronize = { action: 'synchronize'; after: string; before: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -57043,8 +60500,8 @@ export type WebhookPullRequestSynchronize = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request unassigned event @@ -57077,13 +60534,13 @@ export type WebhookPullRequestUnassigned = { type?: 'Bot' | 'User' | 'Organization' | 'Mannequin'; url?: string; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -58088,15 +61545,15 @@ export type WebhookPullRequestUnassigned = { url?: string; } | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * pull_request unlabeled event */ export type WebhookPullRequestUnlabeled = { action: 'unlabeled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * Label @@ -58123,7 +61580,7 @@ export type WebhookPullRequestUnlabeled = { * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -59121,21 +62578,21 @@ export type WebhookPullRequestUnlabeled = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * pull_request unlocked event */ export type WebhookPullRequestUnlocked = { action: 'unlocked'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; /** * The pull request number. */ number: number; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Pull Request */ @@ -60140,8 +63597,8 @@ export type WebhookPullRequestUnlocked = { url?: string; } | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * push event @@ -60157,7 +63614,7 @@ export type WebhookPush = { */ before: string; /** - * An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. + * An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ commits: { /** @@ -60229,7 +63686,7 @@ export type WebhookPush = { * Whether this push deleted the `ref`. */ deleted: boolean; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; /** * Whether this push was a force push of the `ref`. */ @@ -60296,7 +63753,7 @@ export type WebhookPush = { url: string; } | null; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Committer * Metaproperties for Git author/committer information. @@ -60512,13 +63969,13 @@ export type WebhookPush = { */ web_commit_signoff_required?: boolean; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; export type WebhookRegistryPackagePublished = { action: 'published'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; registry_package: { created_at: string | null; description: string | null; @@ -60712,14 +64169,14 @@ export type WebhookRegistryPackagePublished = { } | null; updated_at: string | null; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; export type WebhookRegistryPackageUpdated = { - action: string; - enterprise?: Enterprise; + action: 'updated'; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; registry_package: { created_at: string; description: any | null; @@ -60844,20 +64301,20 @@ export type WebhookRegistryPackageUpdated = { registry: any | null; updated_at: string; }; - repository?: Repository; - sender: SimpleUser; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * release created event */ export type WebhookReleaseCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Release - * The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: { @@ -60977,20 +64434,20 @@ export type WebhookReleaseCreated = { url: string; zipball_url: string | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * release deleted event */ export type WebhookReleaseDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Release - * The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: { @@ -61110,8 +64567,8 @@ export type WebhookReleaseDeleted = { url: string; zipball_url: string | null; }; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * release edited event @@ -61138,12 +64595,12 @@ export type WebhookReleaseEdited = { to: boolean; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Release - * The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: { @@ -61263,17 +64720,17 @@ export type WebhookReleaseEdited = { url: string; zipball_url: string | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * release prereleased event */ export type WebhookReleasePrereleased = { action: 'prereleased'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; release: { assets: { browser_download_url: string; @@ -61433,17 +64890,17 @@ export type WebhookReleasePrereleased = { url?: string; zipball_url?: string | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * release published event */ export type WebhookReleasePublished = { action: 'published'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; release: { assets: { browser_download_url: string; @@ -61600,20 +65057,20 @@ export type WebhookReleasePublished = { url?: string; zipball_url?: string | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * release released event */ export type WebhookReleaseReleased = { action: 'released'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; /** * Release - * The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: { @@ -61733,17 +65190,17 @@ export type WebhookReleaseReleased = { url: string; zipball_url: string | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * release unpublished event */ export type WebhookReleaseUnpublished = { action: 'unpublished'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; release: { assets: { browser_download_url: string; @@ -61900,80 +65357,80 @@ export type WebhookReleaseUnpublished = { url?: string; zipball_url?: string | null; }; - repository: Repository; - sender?: SimpleUser; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * Repository advisory published event */ export type WebhookRepositoryAdvisoryPublished = { action: 'published'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; repository_advisory: RepositoryAdvisory; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * Repository advisory reported event */ export type WebhookRepositoryAdvisoryReported = { action: 'reported'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; repository_advisory: RepositoryAdvisory; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * repository archived event */ export type WebhookRepositoryArchived = { action: 'archived'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository created event */ export type WebhookRepositoryCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository deleted event */ export type WebhookRepositoryDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_dispatch event */ export type WebhookRepositoryDispatchSample = { - action: string; + action: 'sample.collected'; branch: string; client_payload: { [key: string]: any; } | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository edited event @@ -61994,21 +65451,21 @@ export type WebhookRepositoryEdited = { from?: string[] | null; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_import event */ export type WebhookRepositoryImport = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; status: 'success' | 'cancelled' | 'failure'; }; /** @@ -62016,22 +65473,22 @@ export type WebhookRepositoryImport = { */ export type WebhookRepositoryPrivatized = { action: 'privatized'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository publicized event */ export type WebhookRepositoryPublicized = { action: 'publicized'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository renamed event @@ -62045,11 +65502,94 @@ export type WebhookRepositoryRenamed = { }; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; +}; +/** + * repository ruleset created event + */ +export type WebhookRepositoryRulesetCreated = { + action: 'created'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + repository_ruleset: RepositoryRuleset; + sender: SimpleUserWebhooks; +}; +/** + * repository ruleset deleted event + */ +export type WebhookRepositoryRulesetDeleted = { + action: 'deleted'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + repository_ruleset: RepositoryRuleset; + sender: SimpleUserWebhooks; +}; +/** + * repository ruleset edited event + */ +export type WebhookRepositoryRulesetEdited = { + action: 'edited'; + enterprise?: EnterpriseWebhooks; + installation?: SimpleInstallation; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + repository_ruleset: RepositoryRuleset; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: RepositoryRulesetConditions[]; + deleted?: RepositoryRulesetConditions[]; + updated?: { + condition?: RepositoryRulesetConditions; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: RepositoryRule[]; + deleted?: RepositoryRule[]; + updated?: { + rule?: RepositoryRule; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: SimpleUserWebhooks; }; /** * repository transferred event @@ -62106,22 +65646,22 @@ export type WebhookRepositoryTransferred = { }; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository unarchived event */ export type WebhookRepositoryUnarchived = { action: 'unarchived'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_vulnerability_alert create event @@ -62185,11 +65725,11 @@ export type WebhookRepositoryVulnerabilityAlertCreate = { severity?: string; state: 'open'; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_vulnerability_alert dismiss event @@ -62283,11 +65823,11 @@ export type WebhookRepositoryVulnerabilityAlertDismiss = { severity?: string; state: 'dismissed'; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_vulnerability_alert reopen event @@ -62351,11 +65891,11 @@ export type WebhookRepositoryVulnerabilityAlertReopen = { severity?: string; state: 'open'; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * repository_vulnerability_alert resolve event @@ -62421,35 +65961,35 @@ export type WebhookRepositoryVulnerabilityAlertResolve = { severity?: string; state: 'fixed' | 'open'; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * secret_scanning_alert created event */ export type WebhookSecretScanningAlertCreated = { action: 'created'; - alert: SecretScanningAlert; - enterprise?: Enterprise; + alert: SecretScanningAlertWebhook; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * Secret Scanning Alert Location Created Event */ export type WebhookSecretScanningAlertLocationCreated = { action?: 'created'; - alert: SecretScanningAlert; + alert: SecretScanningAlertWebhook; installation?: SimpleInstallation; location: SecretScanningLocation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * Secret Scanning Alert Location Created Event @@ -62465,102 +66005,46 @@ export type WebhookSecretScanningAlertLocationCreatedFormEncoded = { */ export type WebhookSecretScanningAlertReopened = { action: 'reopened'; - alert: SecretScanningAlert; - enterprise?: Enterprise; + alert: SecretScanningAlertWebhook; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * secret_scanning_alert resolved event */ export type WebhookSecretScanningAlertResolved = { action: 'resolved'; - alert: { - created_at?: AlertCreatedAt; - html_url?: AlertHtmlUrl; - /** - * The REST API URL of the code locations for this alert. - */ - locations_url?: string; - number?: AlertNumber; - /** - * Whether push protection was bypassed for the detected secret. - */ - push_protection_bypassed?: boolean | null; - /** - * The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - push_protection_bypassed_at?: Date | null; - push_protection_bypassed_by?: NullableSimpleUser; - /** - * **Required when the `state` is `resolved`.** The reason for resolving the alert. - */ - resolution?: - | ( - | null - | 'false_positive' - | 'wont_fix' - | 'revoked' - | 'used_in_tests' - | 'pattern_deleted' - | 'pattern_edited' - ) - | null; - /** - * The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - resolved_at?: Date | null; - resolved_by?: NullableSimpleUser; - /** - * An optional comment to resolve an alert. - */ - resolution_comment?: string | null; - /** - * The secret that was detected. - */ - secret?: string; - /** - * The type of secret that secret scanning detected. - */ - secret_type?: string; - /** - * User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ - secret_type_display_name?: string; - state?: SecretScanningAlertState; - updated_at?: AlertUpdatedAt; - url?: AlertUrl; - }; - enterprise?: Enterprise; + alert: SecretScanningAlertWebhook; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * secret_scanning_alert revoked event */ export type WebhookSecretScanningAlertRevoked = { action: 'revoked'; - alert: SecretScanningAlert; - enterprise?: Enterprise; + alert: SecretScanningAlertWebhook; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender?: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender?: SimpleUserWebhooks; }; /** * security_advisory published event */ export type WebhookSecurityAdvisoryPublished = { action: 'published'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; /** * The details of the security advisory, including summary, description, and severity. */ @@ -62599,17 +66083,17 @@ export type WebhookSecurityAdvisoryPublished = { }[]; withdrawn_at: string | null; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * security_advisory updated event */ export type WebhookSecurityAdvisoryUpdated = { action: 'updated'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; /** * The details of the security advisory, including summary, description, and severity. */ @@ -62648,17 +66132,17 @@ export type WebhookSecurityAdvisoryUpdated = { }[]; withdrawn_at: string | null; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * security_advisory withdrawn event */ export type WebhookSecurityAdvisoryWithdrawn = { action: 'withdrawn'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; /** * The details of the security advisory, including summary, description, and severity. */ @@ -62697,7 +66181,7 @@ export type WebhookSecurityAdvisoryWithdrawn = { }[]; withdrawn_at: string; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * security_and_analysis event @@ -62708,22 +66192,22 @@ export type WebhookSecurityAndAnalysis = { security_and_analysis?: SecurityAndAnalysis; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; repository: FullRepository; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; }; /** * sponsorship cancelled event */ export type WebhookSponsorshipCancelled = { action: 'cancelled'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -62822,11 +66306,11 @@ export type WebhookSponsorshipCancelled = { */ export type WebhookSponsorshipCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -62933,11 +66417,11 @@ export type WebhookSponsorshipEdited = { from: string; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -63040,11 +66524,11 @@ export type WebhookSponsorshipPendingCancellation = { * The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -63166,11 +66650,11 @@ export type WebhookSponsorshipPendingTierChange = { * The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -63288,11 +66772,11 @@ export type WebhookSponsorshipTierChanged = { }; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository?: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository?: RepositoryWebhooks; + sender: SimpleUserWebhooks; sponsorship: { created_at: string; maintainer?: { @@ -63391,11 +66875,11 @@ export type WebhookSponsorshipTierChanged = { */ export type WebhookStarCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ @@ -63406,11 +66890,11 @@ export type WebhookStarCreated = { */ export type WebhookStarDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ @@ -63558,16 +67042,16 @@ export type WebhookStatus = { * The optional human-readable description added to the status. */ description: string | null; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; /** * The unique identifier of the status. */ id: number; installation?: SimpleInstallation; name: string; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * The Commit SHA. */ @@ -63586,11 +67070,11 @@ export type WebhookStatus = { * team_add event */ export type WebhookTeamAdd = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -63666,9 +67150,9 @@ export type WebhookTeamAdd = { */ export type WebhookTeamAddedToRepository = { action: 'added_to_repository'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; /** * Repository * A git repository @@ -63859,7 +67343,7 @@ export type WebhookTeamAddedToRepository = { watchers: number; watchers_count: number; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -63935,9 +67419,9 @@ export type WebhookTeamAddedToRepository = { */ export type WebhookTeamCreated = { action: 'created'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; /** * Repository * A git repository @@ -64128,7 +67612,7 @@ export type WebhookTeamCreated = { watchers: number; watchers_count: number; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -64204,9 +67688,9 @@ export type WebhookTeamCreated = { */ export type WebhookTeamDeleted = { action: 'deleted'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; /** * Repository * A git repository @@ -64397,7 +67881,7 @@ export type WebhookTeamDeleted = { watchers: number; watchers_count: number; }; - sender?: SimpleUser; + sender?: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -64520,9 +68004,9 @@ export type WebhookTeamEdited = { }; }; }; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; /** * Repository * A git repository @@ -64713,7 +68197,7 @@ export type WebhookTeamEdited = { watchers: number; watchers_count: number; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -64789,9 +68273,9 @@ export type WebhookTeamEdited = { */ export type WebhookTeamRemovedFromRepository = { action: 'removed_from_repository'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization: OrganizationSimple; + organization: OrganizationSimpleWebhooks; /** * Repository * A git repository @@ -64982,7 +68466,7 @@ export type WebhookTeamRemovedFromRepository = { watchers: number; watchers_count: number; }; - sender: SimpleUser; + sender: SimpleUserWebhooks; /** * Team * Groups of organization members that gives permissions on specified repositories. @@ -65058,25 +68542,25 @@ export type WebhookTeamRemovedFromRepository = { */ export type WebhookWatchStarted = { action: 'started'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; }; /** * workflow_dispatch event */ export type WebhookWorkflowDispatch = { - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; inputs: { [key: string]: any; } | null; installation?: SimpleInstallation; - organization?: OrganizationSimple; + organization?: OrganizationSimpleWebhooks; ref: string; - repository: Repository; - sender: SimpleUser; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; workflow: string; }; /** @@ -65084,11 +68568,11 @@ export type WebhookWorkflowDispatch = { */ export type WebhookWorkflowJobCompleted = { action: 'completed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; workflow_job: { check_run_url: string; completed_at: string | null; @@ -65208,11 +68692,11 @@ export type WebhookWorkflowJobCompleted = { */ export type WebhookWorkflowJobInProgress = { action: 'in_progress'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; workflow_job: { check_run_url: string; completed_at: string | null; @@ -65321,11 +68805,11 @@ export type WebhookWorkflowJobInProgress = { */ export type WebhookWorkflowJobQueued = { action: 'queued'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; workflow_job: { check_run_url: string; completed_at: string | null; @@ -65376,11 +68860,11 @@ export type WebhookWorkflowJobQueued = { */ export type WebhookWorkflowJobWaiting = { action: 'waiting'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; workflow_job: { check_run_url: string; completed_at: string | null; @@ -65431,11 +68915,11 @@ export type WebhookWorkflowJobWaiting = { */ export type WebhookWorkflowRunCompleted = { action: 'completed'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * Workflow */ @@ -66029,11 +69513,11 @@ export type WebhookWorkflowRunCompleted = { */ export type WebhookWorkflowRunInProgress = { action: 'in_progress'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * Workflow */ @@ -66624,11 +70108,11 @@ export type WebhookWorkflowRunInProgress = { */ export type WebhookWorkflowRunRequested = { action: 'requested'; - enterprise?: Enterprise; + enterprise?: EnterpriseWebhooks; installation?: SimpleInstallation; - organization?: OrganizationSimple; - repository: Repository; - sender: SimpleUser; + organization?: OrganizationSimpleWebhooks; + repository: RepositoryWebhooks; + sender: SimpleUserWebhooks; /** * Workflow */ @@ -66990,6 +70474,13 @@ export type WebhookWorkflowRunRequested = { display_title: string; }; }; +const $date_GlobalAdvisory = (): r.TransformField[] => [ + [['access', 'published_at'], ['this']], + [['access', 'updated_at'], ['this']], + [['access', 'github_reviewed_at'], ['this']], + [['access', 'nvd_published_at'], ['this']], + [['access', 'withdrawn_at'], ['this']], +]; const $date_Integration = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], @@ -67033,6 +70524,18 @@ const $date_Authorization = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'expires_at'], ['this']], ]; +const $date_ClassroomAssignment = (): r.TransformField[] => [ + [['access', 'deadline'], ['this']], +]; +const $date_SimpleClassroomAssignment = (): r.TransformField[] => [ + [['access', 'deadline'], ['this']], +]; +const $date_ClassroomAcceptedAssignment = (): r.TransformField[] => [ + [ + ['access', 'assignment'], + ['ref', $date_SimpleClassroomAssignment], + ], +]; const $date_DependabotAlertSecurityAdvisory = (): r.TransformField[] => [ [['access', 'published_at'], ['this']], [['access', 'updated_at'], ['this']], @@ -67180,14 +70683,7 @@ const $date_ThreadSubscription = (): r.TransformField[] => [ const $date_OrganizationFull = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], -]; -const $date_RequiredWorkflow = (): r.TransformField[] => [ - [['access', 'created_at'], ['this']], - [['access', 'updated_at'], ['this']], - [ - ['access', 'repository'], - ['ref', $date_MinimalRepository], - ], + [['access', 'archived_at'], ['this']], ]; const $date_AuthenticationToken = (): r.TransformField[] => [ [['access', 'expires_at'], ['this']], @@ -67233,6 +70729,19 @@ const $date_CodespacesOrgSecret = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], ]; +const $date_Organization = (): r.TransformField[] => [ + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], +]; +const $date_CopilotSeatDetails = (): r.TransformField[] => [ + [ + ['access', 'assignee'], + ['select', [[['ref', $date_Organization]]]], + ], + [['access', 'last_activity_at'], ['this']], + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], +]; const $date_OrganizationDependabotSecret = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], @@ -67275,9 +70784,23 @@ const $date_RepositoryRuleset = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], ]; +const $date_RuleSuites = (): r.TransformField[] => [ + [['loop'], ['access', 'pushed_at'], ['this']], +]; +const $date_RuleSuite = (): r.TransformField[] => [ + [['access', 'pushed_at'], ['this']], +]; +const $date_RepositoryAdvisory = (): r.TransformField[] => [ + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], + [['access', 'published_at'], ['this']], + [['access', 'closed_at'], ['this']], + [['access', 'withdrawn_at'], ['this']], +]; const $date_TeamOrganization = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], + [['access', 'archived_at'], ['this']], ]; const $date_TeamFull = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], @@ -67322,14 +70845,6 @@ const $date_ProjectColumn = (): r.TransformField[] => [ [['access', 'created_at'], ['this']], [['access', 'updated_at'], ['this']], ]; -const $date_RepoRequiredWorkflow = (): r.TransformField[] => [ - [ - ['access', 'source_repository'], - ['ref', $date_MinimalRepository], - ], - [['access', 'created_at'], ['this']], - [['access', 'updated_at'], ['this']], -]; const $date_FullRepository = (): r.TransformField[] => [ [['access', 'pushed_at'], ['this']], [['access', 'created_at'], ['this']], @@ -67416,6 +70931,9 @@ const $date_Workflow = (): r.TransformField[] => [ [['access', 'updated_at'], ['this']], [['access', 'deleted_at'], ['this']], ]; +const $date_Activity = (): r.TransformField[] => [ + [['access', 'timestamp'], ['this']], +]; const $date_ProtectedBranchPullRequestReview = (): r.TransformField[] => [ [ ['access', 'dismissal_restrictions'], @@ -67886,13 +71404,6 @@ const $date_SecretScanningAlert = (): r.TransformField[] => [ [['access', 'resolved_at'], ['this']], [['access', 'push_protection_bypassed_at'], ['this']], ]; -const $date_RepositoryAdvisory = (): r.TransformField[] => [ - [['access', 'created_at'], ['this']], - [['access', 'updated_at'], ['this']], - [['access', 'published_at'], ['this']], - [['access', 'closed_at'], ['this']], - [['access', 'withdrawn_at'], ['this']], -]; const $date_Stargazer = (): r.TransformField[] => [ [['access', 'starred_at'], ['this']], ]; @@ -67998,6 +71509,15 @@ const $date_StarredRepository = (): r.TransformField[] => [ ['ref', $date_Repository], ], ]; +const $date_EnterpriseWebhooks = (): r.TransformField[] => [ + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], +]; +const $date_RepositoryWebhooks = (): r.TransformField[] => [ + [['access', 'pushed_at'], ['this']], + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], +]; const $date_SimpleCheckSuite = (): r.TransformField[] => [ [ ['access', 'app'], @@ -68037,6 +71557,11 @@ const $date_MergeGroup = (): r.TransformField[] => [ ['ref', $date_SimpleCommit], ], ]; +const $date_NullableRepositoryWebhooks = (): r.TransformField[] => [ + [['access', 'pushed_at'], ['this']], + [['access', 'created_at'], ['this']], + [['access', 'updated_at'], ['this']], +]; const $date_ProjectsV2 = (): r.TransformField[] => [ [['access', 'closed_at'], ['this']], [['access', 'created_at'], ['this']], @@ -68048,14 +71573,48 @@ const $date_ProjectsV2Item = (): r.TransformField[] => [ [['access', 'updated_at'], ['this']], [['access', 'archived_at'], ['this']], ]; +const $date_SecretScanningAlertWebhook = (): r.TransformField[] => [ + [ + ['access', 'created_at'], + ['ref', $date_AlertCreatedAt], + ], + [ + ['access', 'updated_at'], + ['ref', $date_NullableAlertUpdatedAt], + ], + [['access', 'resolved_at'], ['this']], + [['access', 'push_protection_bypassed_at'], ['this']], +]; +const $date_WebhookBranchProtectionConfigurationDisabled = + (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + ]; +const $date_WebhookBranchProtectionConfigurationEnabled = + (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + ]; const $date_WebhookBranchProtectionRuleCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'rule'], ['access', 'created_at'], ['this']], [['access', 'rule'], ['access', 'updated_at'], ['this']], @@ -68063,11 +71622,11 @@ const $date_WebhookBranchProtectionRuleCreated = (): r.TransformField[] => [ const $date_WebhookBranchProtectionRuleDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'rule'], ['access', 'created_at'], ['this']], [['access', 'rule'], ['access', 'updated_at'], ['this']], @@ -68075,11 +71634,11 @@ const $date_WebhookBranchProtectionRuleDeleted = (): r.TransformField[] => [ const $date_WebhookBranchProtectionRuleEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'rule'], ['access', 'created_at'], ['this']], [['access', 'rule'], ['access', 'updated_at'], ['this']], @@ -68091,7 +71650,7 @@ const $date_WebhookCheckRunCompleted = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckRunCreated = (): r.TransformField[] => [ @@ -68101,7 +71660,7 @@ const $date_WebhookCheckRunCreated = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckRunRequestedAction = (): r.TransformField[] => [ @@ -68111,7 +71670,7 @@ const $date_WebhookCheckRunRequestedAction = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckRunRerequested = (): r.TransformField[] => [ @@ -68121,7 +71680,7 @@ const $date_WebhookCheckRunRerequested = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckSuiteCompleted = (): r.TransformField[] => [ @@ -68155,11 +71714,11 @@ const $date_WebhookCheckSuiteCompleted = (): r.TransformField[] => [ [['access', 'check_suite'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckSuiteRequested = (): r.TransformField[] => [ @@ -68193,11 +71752,11 @@ const $date_WebhookCheckSuiteRequested = (): r.TransformField[] => [ [['access', 'check_suite'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCheckSuiteRerequested = (): r.TransformField[] => [ @@ -68231,11 +71790,11 @@ const $date_WebhookCheckSuiteRerequested = (): r.TransformField[] => [ [['access', 'check_suite'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertAppearedInBranch = @@ -68244,11 +71803,11 @@ const $date_WebhookCodeScanningAlertAppearedInBranch = [['access', 'alert'], ['access', 'dismissed_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertClosedByUser = (): r.TransformField[] => [ @@ -68256,22 +71815,22 @@ const $date_WebhookCodeScanningAlertClosedByUser = (): r.TransformField[] => [ [['access', 'alert'], ['access', 'dismissed_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertCreated = (): r.TransformField[] => [ [['access', 'alert'], ['access', 'created_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertFixed = (): r.TransformField[] => [ @@ -68279,153 +71838,153 @@ const $date_WebhookCodeScanningAlertFixed = (): r.TransformField[] => [ [['access', 'alert'], ['access', 'dismissed_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertReopened = (): r.TransformField[] => [ [['access', 'alert'], ['access', 'created_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCodeScanningAlertReopenedByUser = (): r.TransformField[] => [ [['access', 'alert'], ['access', 'created_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCommitCommentCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookCreate = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDelete = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertAutoDismissed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertAutoReopened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertDismissed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertFixed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertReintroduced = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDependabotAlertReopened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDeployKeyCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDeployKeyDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDeploymentCreated = (): r.TransformField[] => [ @@ -68443,11 +72002,11 @@ const $date_WebhookDeploymentCreated = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow'], ['access', 'created_at'], ['this']], [['access', 'workflow'], ['access', 'updated_at'], ['this']], @@ -68464,9 +72023,48 @@ const $date_WebhookDeploymentProtectionRuleRequested = [['access', 'pull_requests'], ['loop'], ['ref', $date_PullRequest]], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; +const $date_WebhookDeploymentReviewApproved = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [['access', 'workflow_run'], ['access', 'created_at'], ['this']], + [['access', 'workflow_run'], ['access', 'run_started_at'], ['this']], + [['access', 'workflow_run'], ['access', 'updated_at'], ['this']], +]; +const $date_WebhookDeploymentReviewRejected = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [['access', 'workflow_run'], ['access', 'created_at'], ['this']], + [['access', 'workflow_run'], ['access', 'run_started_at'], ['this']], + [['access', 'workflow_run'], ['access', 'updated_at'], ['this']], +]; +const $date_WebhookDeploymentReviewRequested = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [['access', 'workflow_run'], ['access', 'created_at'], ['this']], + [['access', 'workflow_run'], ['access', 'run_started_at'], ['this']], + [['access', 'workflow_run'], ['access', 'updated_at'], ['this']], +]; const $date_WebhookDeploymentStatusCreated = (): r.TransformField[] => [ [['access', 'check_run'], ['access', 'completed_at'], ['this']], [['access', 'check_run'], ['access', 'started_at'], ['this']], @@ -68496,11 +72094,11 @@ const $date_WebhookDeploymentStatusCreated = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow'], ['access', 'created_at'], ['this']], [['access', 'workflow'], ['access', 'updated_at'], ['this']], @@ -68517,11 +72115,11 @@ const $date_WebhookDiscussionAnswered = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionCategoryChanged = (): r.TransformField[] => [ @@ -68538,11 +72136,11 @@ const $date_WebhookDiscussionCategoryChanged = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionClosed = (): r.TransformField[] => [ @@ -68552,11 +72150,11 @@ const $date_WebhookDiscussionClosed = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionCommentCreated = (): r.TransformField[] => [ @@ -68566,11 +72164,11 @@ const $date_WebhookDiscussionCommentCreated = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionCommentDeleted = (): r.TransformField[] => [ @@ -68580,11 +72178,11 @@ const $date_WebhookDiscussionCommentDeleted = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionCommentEdited = (): r.TransformField[] => [ @@ -68594,11 +72192,11 @@ const $date_WebhookDiscussionCommentEdited = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionCreated = (): r.TransformField[] => [ @@ -68615,11 +72213,11 @@ const $date_WebhookDiscussionCreated = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionDeleted = (): r.TransformField[] => [ @@ -68629,11 +72227,11 @@ const $date_WebhookDiscussionDeleted = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionEdited = (): r.TransformField[] => [ @@ -68643,11 +72241,11 @@ const $date_WebhookDiscussionEdited = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionLabeled = (): r.TransformField[] => [ @@ -68657,11 +72255,11 @@ const $date_WebhookDiscussionLabeled = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionLocked = (): r.TransformField[] => [ @@ -68671,11 +72269,11 @@ const $date_WebhookDiscussionLocked = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionPinned = (): r.TransformField[] => [ @@ -68685,11 +72283,11 @@ const $date_WebhookDiscussionPinned = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionReopened = (): r.TransformField[] => [ @@ -68699,11 +72297,11 @@ const $date_WebhookDiscussionReopened = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionTransferred = (): r.TransformField[] => [ @@ -68715,7 +72313,7 @@ const $date_WebhookDiscussionTransferred = (): r.TransformField[] => [ [ ['access', 'changes'], ['access', 'new_repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'discussion'], @@ -68723,11 +72321,11 @@ const $date_WebhookDiscussionTransferred = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionUnanswered = (): r.TransformField[] => [ @@ -68739,7 +72337,7 @@ const $date_WebhookDiscussionUnanswered = (): r.TransformField[] => [ [['access', 'old_answer'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionUnlabeled = (): r.TransformField[] => [ @@ -68749,11 +72347,11 @@ const $date_WebhookDiscussionUnlabeled = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionUnlocked = (): r.TransformField[] => [ @@ -68763,11 +72361,11 @@ const $date_WebhookDiscussionUnlocked = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookDiscussionUnpinned = (): r.TransformField[] => [ @@ -68777,17 +72375,17 @@ const $date_WebhookDiscussionUnpinned = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookFork = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'forkee'], @@ -68808,33 +72406,33 @@ const $date_WebhookFork = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookGithubAppAuthorizationRevoked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookGollum = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68842,13 +72440,13 @@ const $date_WebhookInstallationCreated = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68856,14 +72454,14 @@ const $date_WebhookInstallationDeleted = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationNewPermissionsAccepted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68871,13 +72469,13 @@ const $date_WebhookInstallationNewPermissionsAccepted = ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationRepositoriesAdded = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68885,13 +72483,13 @@ const $date_WebhookInstallationRepositoriesAdded = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationRepositoriesRemoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68899,13 +72497,13 @@ const $date_WebhookInstallationRepositoriesRemoved = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationSuspend = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68913,23 +72511,23 @@ const $date_WebhookInstallationSuspend = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationTargetRenamed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookInstallationUnsuspend = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'installation'], @@ -68937,7 +72535,7 @@ const $date_WebhookInstallationUnsuspend = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssueCommentCreated = (): r.TransformField[] => [ @@ -68950,7 +72548,7 @@ const $date_WebhookIssueCommentCreated = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -68980,7 +72578,7 @@ const $date_WebhookIssueCommentCreated = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssueCommentDeleted = (): r.TransformField[] => [ @@ -68993,7 +72591,7 @@ const $date_WebhookIssueCommentDeleted = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69023,7 +72621,7 @@ const $date_WebhookIssueCommentDeleted = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssueCommentEdited = (): r.TransformField[] => [ @@ -69036,7 +72634,7 @@ const $date_WebhookIssueCommentEdited = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69066,13 +72664,13 @@ const $date_WebhookIssueCommentEdited = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesAssigned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69121,13 +72719,13 @@ const $date_WebhookIssuesAssigned = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesClosed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69157,13 +72755,13 @@ const $date_WebhookIssuesClosed = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69212,13 +72810,13 @@ const $date_WebhookIssuesDeleted = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesDemilestoned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69256,13 +72854,13 @@ const $date_WebhookIssuesDemilestoned = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69311,13 +72909,13 @@ const $date_WebhookIssuesEdited = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesLabeled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69366,13 +72964,13 @@ const $date_WebhookIssuesLabeled = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesLocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69402,13 +73000,13 @@ const $date_WebhookIssuesLocked = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesMilestoned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69446,7 +73044,7 @@ const $date_WebhookIssuesMilestoned = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesOpened = (): r.TransformField[] => [ @@ -69537,7 +73135,7 @@ const $date_WebhookIssuesOpened = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69586,13 +73184,13 @@ const $date_WebhookIssuesOpened = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesPinned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69641,13 +73239,13 @@ const $date_WebhookIssuesPinned = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesReopened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69677,7 +73275,7 @@ const $date_WebhookIssuesReopened = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesTransferred = (): r.TransformField[] => [ @@ -69768,7 +73366,7 @@ const $date_WebhookIssuesTransferred = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69817,13 +73415,13 @@ const $date_WebhookIssuesTransferred = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesUnassigned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69872,13 +73470,13 @@ const $date_WebhookIssuesUnassigned = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesUnlabeled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -69927,13 +73525,13 @@ const $date_WebhookIssuesUnlabeled = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesUnlocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'issue'], @@ -69963,13 +73561,13 @@ const $date_WebhookIssuesUnlocked = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookIssuesUnpinned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'issue'], ['access', 'closed_at'], ['this']], [['access', 'issue'], ['access', 'created_at'], ['this']], @@ -70018,167 +73616,167 @@ const $date_WebhookIssuesUnpinned = (): r.TransformField[] => [ [['access', 'issue'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookLabelCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookLabelDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookLabelEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMarketplacePurchaseCancelled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMarketplacePurchaseChanged = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMarketplacePurchasePendingChange = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMarketplacePurchasePendingChangeCancelled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMarketplacePurchasePurchased = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMemberAdded = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMemberEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMemberRemoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMembershipAdded = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMembershipRemoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMergeGroupChecksRequested = (): r.TransformField[] => [ [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMergeGroupDestroyed = (): r.TransformField[] => [ [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMetaDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_NullableRepository], + ['ref', $date_NullableRepositoryWebhooks], ], ]; const $date_WebhookMilestoneClosed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'milestone'], ['access', 'closed_at'], ['this']], [['access', 'milestone'], ['access', 'created_at'], ['this']], @@ -70186,13 +73784,13 @@ const $date_WebhookMilestoneClosed = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMilestoneCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'milestone'], ['access', 'closed_at'], ['this']], [['access', 'milestone'], ['access', 'created_at'], ['this']], @@ -70200,13 +73798,13 @@ const $date_WebhookMilestoneCreated = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMilestoneDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'milestone'], ['access', 'closed_at'], ['this']], [['access', 'milestone'], ['access', 'created_at'], ['this']], @@ -70214,13 +73812,13 @@ const $date_WebhookMilestoneDeleted = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMilestoneEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'milestone'], ['access', 'closed_at'], ['this']], [['access', 'milestone'], ['access', 'created_at'], ['this']], @@ -70228,13 +73826,13 @@ const $date_WebhookMilestoneEdited = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookMilestoneOpened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'milestone'], ['access', 'closed_at'], ['this']], [['access', 'milestone'], ['access', 'created_at'], ['this']], @@ -70242,109 +73840,109 @@ const $date_WebhookMilestoneOpened = (): r.TransformField[] => [ [['access', 'milestone'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrgBlockBlocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrgBlockUnblocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrganizationDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrganizationMemberAdded = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrganizationMemberInvited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'invitation'], ['access', 'created_at'], ['this']], [['access', 'invitation'], ['access', 'failed_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrganizationMemberRemoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookOrganizationRenamed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPackagePublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPackageUpdated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPageBuild = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPing = (): r.TransformField[] => [ @@ -70352,61 +73950,61 @@ const $date_WebhookPing = (): r.TransformField[] => [ [['access', 'hook'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectCardConverted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_card'], ['access', 'created_at'], ['this']], [['access', 'project_card'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectCardCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_card'], ['access', 'created_at'], ['this']], [['access', 'project_card'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectCardDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_card'], ['access', 'created_at'], ['this']], [['access', 'project_card'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_NullableRepository], + ['ref', $date_NullableRepositoryWebhooks], ], ]; const $date_WebhookProjectCardEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_card'], ['access', 'created_at'], ['this']], [['access', 'project_card'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectCardMoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'project_card'], @@ -70420,115 +74018,115 @@ const $date_WebhookProjectCardMoved = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectClosed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project'], ['access', 'created_at'], ['this']], [['access', 'project'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectColumnCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_column'], ['access', 'created_at'], ['this']], [['access', 'project_column'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectColumnDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_column'], ['access', 'created_at'], ['this']], [['access', 'project_column'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_NullableRepository], + ['ref', $date_NullableRepositoryWebhooks], ], ]; const $date_WebhookProjectColumnEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_column'], ['access', 'created_at'], ['this']], [['access', 'project_column'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectColumnMoved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project_column'], ['access', 'created_at'], ['this']], [['access', 'project_column'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project'], ['access', 'created_at'], ['this']], [['access', 'project'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project'], ['access', 'created_at'], ['this']], [['access', 'project'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_NullableRepository], + ['ref', $date_NullableRepositoryWebhooks], ], ]; const $date_WebhookProjectEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project'], ['access', 'created_at'], ['this']], [['access', 'project'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectReopened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [['access', 'project'], ['access', 'created_at'], ['this']], [['access', 'project'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookProjectsV2ProjectClosed = (): r.TransformField[] => [ @@ -70630,17 +74228,17 @@ const $date_WebhookProjectsV2ProjectReopened = (): r.TransformField[] => [ const $date_WebhookPublic = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestAssigned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -70714,13 +74312,13 @@ const $date_WebhookPullRequestAssigned = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestAutoMergeDisabled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -70794,13 +74392,13 @@ const $date_WebhookPullRequestAutoMergeDisabled = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestAutoMergeEnabled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -70874,13 +74472,13 @@ const $date_WebhookPullRequestAutoMergeEnabled = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestClosed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -70888,13 +74486,13 @@ const $date_WebhookPullRequestClosed = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestConvertedToDraft = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -70902,13 +74500,13 @@ const $date_WebhookPullRequestConvertedToDraft = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestDemilestoned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'milestone'], @@ -70986,13 +74584,13 @@ const $date_WebhookPullRequestDemilestoned = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestDequeued = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71066,13 +74664,13 @@ const $date_WebhookPullRequestDequeued = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71080,13 +74678,13 @@ const $date_WebhookPullRequestEdited = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestEnqueued = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71160,13 +74758,13 @@ const $date_WebhookPullRequestEnqueued = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestLabeled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71240,13 +74838,13 @@ const $date_WebhookPullRequestLabeled = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestLocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71320,13 +74918,13 @@ const $date_WebhookPullRequestLocked = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestMilestoned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'milestone'], @@ -71404,13 +75002,13 @@ const $date_WebhookPullRequestMilestoned = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestOpened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71418,13 +75016,13 @@ const $date_WebhookPullRequestOpened = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReadyForReview = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71432,13 +75030,13 @@ const $date_WebhookPullRequestReadyForReview = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReopened = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71446,7 +75044,7 @@ const $date_WebhookPullRequestReopened = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReviewCommentCreated = (): r.TransformField[] => [ @@ -71454,7 +75052,7 @@ const $date_WebhookPullRequestReviewCommentCreated = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71524,7 +75122,7 @@ const $date_WebhookPullRequestReviewCommentCreated = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReviewCommentDeleted = (): r.TransformField[] => [ @@ -71532,7 +75130,7 @@ const $date_WebhookPullRequestReviewCommentDeleted = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71602,7 +75200,7 @@ const $date_WebhookPullRequestReviewCommentDeleted = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReviewCommentEdited = (): r.TransformField[] => [ @@ -71610,7 +75208,7 @@ const $date_WebhookPullRequestReviewCommentEdited = (): r.TransformField[] => [ [['access', 'comment'], ['access', 'updated_at'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71680,13 +75278,13 @@ const $date_WebhookPullRequestReviewCommentEdited = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestReviewDismissed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71756,14 +75354,14 @@ const $date_WebhookPullRequestReviewDismissed = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'review'], ['access', 'submitted_at'], ['this']], ]; const $date_WebhookPullRequestReviewEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71833,7 +75431,7 @@ const $date_WebhookPullRequestReviewEdited = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'review'], ['access', 'submitted_at'], ['this']], ]; @@ -71844,7 +75442,7 @@ const $date_WebhookPullRequestReviewRequestRemoved = (): r.TransformField[] => [ [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71918,11 +75516,11 @@ const $date_WebhookPullRequestReviewRequestRemoved = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -71996,7 +75594,7 @@ const $date_WebhookPullRequestReviewRequestRemoved = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ], ], @@ -72009,7 +75607,7 @@ const $date_WebhookPullRequestReviewRequested = (): r.TransformField[] => [ [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72083,11 +75681,11 @@ const $date_WebhookPullRequestReviewRequested = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72161,7 +75759,7 @@ const $date_WebhookPullRequestReviewRequested = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ], ], @@ -72170,7 +75768,7 @@ const $date_WebhookPullRequestReviewRequested = (): r.TransformField[] => [ const $date_WebhookPullRequestReviewSubmitted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72240,14 +75838,14 @@ const $date_WebhookPullRequestReviewSubmitted = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'review'], ['access', 'submitted_at'], ['this']], ]; const $date_WebhookPullRequestReviewThreadResolved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72317,7 +75915,7 @@ const $date_WebhookPullRequestReviewThreadResolved = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'thread'], @@ -72338,7 +75936,7 @@ const $date_WebhookPullRequestReviewThreadUnresolved = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72408,7 +76006,7 @@ const $date_WebhookPullRequestReviewThreadUnresolved = ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'thread'], @@ -72428,7 +76026,7 @@ const $date_WebhookPullRequestReviewThreadUnresolved = const $date_WebhookPullRequestSynchronize = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72502,13 +76100,13 @@ const $date_WebhookPullRequestSynchronize = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestUnassigned = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72582,13 +76180,13 @@ const $date_WebhookPullRequestUnassigned = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestUnlabeled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72662,13 +76260,13 @@ const $date_WebhookPullRequestUnlabeled = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPullRequestUnlocked = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'pull_request'], @@ -72742,7 +76340,7 @@ const $date_WebhookPullRequestUnlocked = (): r.TransformField[] => [ [['access', 'pull_request'], ['access', 'updated_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookPush = (): r.TransformField[] => [ @@ -72763,7 +76361,7 @@ const $date_WebhookPush = (): r.TransformField[] => [ [['access', 'commits'], ['loop'], ['access', 'timestamp'], ['this']], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'head_commit'], @@ -72794,27 +76392,27 @@ const $date_WebhookPush = (): r.TransformField[] => [ const $date_WebhookRegistryPackagePublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRegistryPackageUpdated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleaseCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72834,13 +76432,13 @@ const $date_WebhookReleaseCreated = (): r.TransformField[] => [ [['access', 'release'], ['access', 'published_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleaseDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72860,13 +76458,13 @@ const $date_WebhookReleaseDeleted = (): r.TransformField[] => [ [['access', 'release'], ['access', 'published_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleaseEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72886,13 +76484,13 @@ const $date_WebhookReleaseEdited = (): r.TransformField[] => [ [['access', 'release'], ['access', 'published_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleasePrereleased = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72908,13 +76506,13 @@ const $date_WebhookReleasePrereleased = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleasePublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72931,13 +76529,13 @@ const $date_WebhookReleasePublished = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleaseReleased = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72957,13 +76555,13 @@ const $date_WebhookReleaseReleased = (): r.TransformField[] => [ [['access', 'release'], ['access', 'published_at'], ['this']], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookReleaseUnpublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'release'], @@ -72979,17 +76577,17 @@ const $date_WebhookReleaseUnpublished = (): r.TransformField[] => [ ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryAdvisoryPublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'repository_advisory'], @@ -72999,11 +76597,11 @@ const $date_WebhookRepositoryAdvisoryPublished = (): r.TransformField[] => [ const $date_WebhookRepositoryAdvisoryReported = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'repository_advisory'], @@ -73013,111 +76611,153 @@ const $date_WebhookRepositoryAdvisoryReported = (): r.TransformField[] => [ const $date_WebhookRepositoryArchived = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryDispatchSample = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryImport = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryPrivatized = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryPublicized = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryRenamed = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], + ], +]; +const $date_WebhookRepositoryRulesetCreated = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [ + ['access', 'repository_ruleset'], + ['ref', $date_RepositoryRuleset], + ], +]; +const $date_WebhookRepositoryRulesetDeleted = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [ + ['access', 'repository_ruleset'], + ['ref', $date_RepositoryRuleset], + ], +]; +const $date_WebhookRepositoryRulesetEdited = (): r.TransformField[] => [ + [ + ['access', 'enterprise'], + ['ref', $date_EnterpriseWebhooks], + ], + [ + ['access', 'repository'], + ['ref', $date_RepositoryWebhooks], + ], + [ + ['access', 'repository_ruleset'], + ['ref', $date_RepositoryRuleset], ], ]; const $date_WebhookRepositoryTransferred = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryUnarchived = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryVulnerabilityAlertCreate = @@ -73128,11 +76768,11 @@ const $date_WebhookRepositoryVulnerabilityAlertCreate = ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryVulnerabilityAlertDismiss = @@ -73143,11 +76783,11 @@ const $date_WebhookRepositoryVulnerabilityAlertDismiss = ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryVulnerabilityAlertReopen = @@ -73158,11 +76798,11 @@ const $date_WebhookRepositoryVulnerabilityAlertReopen = ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookRepositoryVulnerabilityAlertResolve = @@ -73179,122 +76819,114 @@ const $date_WebhookRepositoryVulnerabilityAlertResolve = ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecretScanningAlertCreated = (): r.TransformField[] => [ [ ['access', 'alert'], - ['ref', $date_SecretScanningAlert], + ['ref', $date_SecretScanningAlertWebhook], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecretScanningAlertLocationCreated = (): r.TransformField[] => [ [ ['access', 'alert'], - ['ref', $date_SecretScanningAlert], + ['ref', $date_SecretScanningAlertWebhook], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecretScanningAlertReopened = (): r.TransformField[] => [ [ ['access', 'alert'], - ['ref', $date_SecretScanningAlert], + ['ref', $date_SecretScanningAlertWebhook], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecretScanningAlertResolved = (): r.TransformField[] => [ [ ['access', 'alert'], - ['access', 'created_at'], - ['ref', $date_AlertCreatedAt], - ], - [['access', 'alert'], ['access', 'push_protection_bypassed_at'], ['this']], - [['access', 'alert'], ['access', 'resolved_at'], ['this']], - [ - ['access', 'alert'], - ['access', 'updated_at'], - ['ref', $date_AlertUpdatedAt], + ['ref', $date_SecretScanningAlertWebhook], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecretScanningAlertRevoked = (): r.TransformField[] => [ [ ['access', 'alert'], - ['ref', $date_SecretScanningAlert], + ['ref', $date_SecretScanningAlertWebhook], ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecurityAdvisoryPublished = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecurityAdvisoryUpdated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecurityAdvisoryWithdrawn = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSecurityAndAnalysis = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73304,81 +76936,81 @@ const $date_WebhookSecurityAndAnalysis = (): r.TransformField[] => [ const $date_WebhookSponsorshipCancelled = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSponsorshipCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSponsorshipEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSponsorshipPendingCancellation = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSponsorshipPendingTierChange = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookSponsorshipTierChanged = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookStarCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookStarDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookStatus = (): r.TransformField[] => [ @@ -73396,27 +77028,27 @@ const $date_WebhookStatus = (): r.TransformField[] => [ ], [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookTeamAdd = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookTeamAddedToRepository = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73433,7 +77065,7 @@ const $date_WebhookTeamAddedToRepository = (): r.TransformField[] => [ const $date_WebhookTeamCreated = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73450,7 +77082,7 @@ const $date_WebhookTeamCreated = (): r.TransformField[] => [ const $date_WebhookTeamDeleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73467,7 +77099,7 @@ const $date_WebhookTeamDeleted = (): r.TransformField[] => [ const $date_WebhookTeamEdited = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73484,7 +77116,7 @@ const $date_WebhookTeamEdited = (): r.TransformField[] => [ const $date_WebhookTeamRemovedFromRepository = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], @@ -73501,31 +77133,31 @@ const $date_WebhookTeamRemovedFromRepository = (): r.TransformField[] => [ const $date_WebhookWatchStarted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookWorkflowDispatch = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], ]; const $date_WebhookWorkflowJobCompleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'deployment'], @@ -73535,11 +77167,11 @@ const $date_WebhookWorkflowJobCompleted = (): r.TransformField[] => [ const $date_WebhookWorkflowJobInProgress = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [ ['access', 'deployment'], @@ -73549,11 +77181,11 @@ const $date_WebhookWorkflowJobInProgress = (): r.TransformField[] => [ const $date_WebhookWorkflowJobQueued = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow_job'], ['access', 'started_at'], ['this']], [ @@ -73564,11 +77196,11 @@ const $date_WebhookWorkflowJobQueued = (): r.TransformField[] => [ const $date_WebhookWorkflowJobWaiting = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow_job'], ['access', 'started_at'], ['this']], [ @@ -73579,11 +77211,11 @@ const $date_WebhookWorkflowJobWaiting = (): r.TransformField[] => [ const $date_WebhookWorkflowRunCompleted = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow'], ['access', 'created_at'], ['this']], [['access', 'workflow'], ['access', 'updated_at'], ['this']], @@ -73614,11 +77246,11 @@ const $date_WebhookWorkflowRunCompleted = (): r.TransformField[] => [ const $date_WebhookWorkflowRunInProgress = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow'], ['access', 'created_at'], ['this']], [['access', 'workflow'], ['access', 'updated_at'], ['this']], @@ -73649,11 +77281,11 @@ const $date_WebhookWorkflowRunInProgress = (): r.TransformField[] => [ const $date_WebhookWorkflowRunRequested = (): r.TransformField[] => [ [ ['access', 'enterprise'], - ['ref', $date_Enterprise], + ['ref', $date_EnterpriseWebhooks], ], [ ['access', 'repository'], - ['ref', $date_Repository], + ['ref', $date_RepositoryWebhooks], ], [['access', 'workflow'], ['access', 'created_at'], ['this']], [['access', 'workflow'], ['access', 'updated_at'], ['this']], @@ -73691,7 +77323,7 @@ export function createContext( /** * GitHub API Root * Get Hypermedia links to resources accessible in GitHub's REST API - * Learn more at {@link https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint} + * Learn more at {@link https://docs.github.com/rest/meta/meta#github-api-root} * Tags: meta */ export async function metaRoot( @@ -73707,18 +77339,117 @@ export async function metaRoot( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * List global security advisories + * Lists all global security advisories that match the specified parameters. If no other parameters are defined, the + * request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude + * advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must + * include the `type` parameter in your request, with the value `malware`. For more information about the different types + * of security advisories, see "[About the GitHub Advisory + * database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * Learn more at {@link https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories} + * Tags: security-advisories + */ +export async function securityAdvisoriesListGlobalAdvisories( + ctx: r.Context, + params: { + ghsa_id?: string; + type?: 'reviewed' | 'malware' | 'unreviewed'; + cve_id?: string; + ecosystem?: + | 'actions' + | 'composer' + | 'erlang' + | 'go' + | 'maven' + | 'npm' + | 'nuget' + | 'other' + | 'pip' + | 'pub' + | 'rubygems' + | 'rust'; + severity?: 'unknown' | 'low' | 'medium' | 'high' | 'critical'; + cwes?: string | string[]; + is_withdrawn?: boolean; + affects?: string | string[]; + published?: string; + updated?: string; + modified?: string; + before?: string; + after?: string; + direction?: 'asc' | 'desc'; + per_page?: number; + sort?: 'updated' | 'published'; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/advisories', + params, + method: r.HttpMethod.GET, + queryParams: [ + 'ghsa_id', + 'type', + 'cve_id', + 'ecosystem', + 'severity', + 'cwes', + 'is_withdrawn', + 'affects', + 'published', + 'updated', + 'modified', + 'before', + 'after', + 'direction', + 'per_page', + 'sort', + ], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { + transforms: { date: [[['loop'], ['ref', $date_GlobalAdvisory]]] }, + }, + }); +} +/** + * Get a global security advisory + * Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + * Learn more at {@link https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory} + * Tags: security-advisories + */ +export async function securityAdvisoriesGetGlobalAdvisory( + ctx: r.Context, + params: { + ghsa_id: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/advisories/{ghsa_id}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_GlobalAdvisory]]] } }, + }); +} /** * Get the authenticated app * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are * associated with this GitHub App, see the `installations_count` in the response. For more details about your app's * installations, see the "[List installations for the authenticated - * app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use - * a + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-the-authenticated-app} * Tags: apps */ export async function appsGetAuthenticated( @@ -73742,7 +77473,7 @@ export async function appsGetAuthenticated( * 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`. - * Learn more at {@link https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest} + * Learn more at {@link https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest} * Tags: apps */ export async function appsCreateFromManifest( @@ -73782,7 +77513,7 @@ export async function appsCreateFromManifest( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app} + * Learn more at {@link https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app} * Tags: apps */ export async function appsGetWebhookConfigForApp( @@ -73806,7 +77537,7 @@ export async function appsGetWebhookConfigForApp( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app} + * Learn more at {@link https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app} * Tags: apps */ export async function appsUpdateWebhookConfigForApp( @@ -73836,7 +77567,7 @@ export async function appsUpdateWebhookConfigForApp( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook} + * Learn more at {@link https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook} * Tags: apps */ export async function appsListWebhookDeliveries( @@ -73868,7 +77599,7 @@ export async function appsListWebhookDeliveries( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook} + * Learn more at {@link https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook} * Tags: apps */ export async function appsGetWebhookDelivery( @@ -73895,7 +77626,7 @@ export async function appsGetWebhookDelivery( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook} + * Learn more at {@link https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook} * Tags: apps */ export async function appsRedeliverWebhookDelivery( @@ -73916,7 +77647,7 @@ export async function appsRedeliverWebhookDelivery( /** * List installation requests for the authenticated app * Lists all the pending installation requests for the authenticated GitHub App. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-installation-requests-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app} * Tags: apps */ export async function appsListInstallationRequestsForAuthenticatedApp< @@ -73951,7 +77682,7 @@ export async function appsListInstallationRequestsForAuthenticatedApp< * to access this endpoint. * * The permissions the installation has are included under the `permissions` key. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app} * Tags: apps */ export async function appsListInstallations( @@ -73982,7 +77713,7 @@ export async function appsListInstallations( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app} * Tags: apps */ export async function appsGetInstallation( @@ -74006,12 +77737,12 @@ export async function appsGetInstallation( * Delete an installation for the authenticated app * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's * access to your account's resources, then we recommend the "[Suspend an app - * installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a * [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) * to access this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app} * Tags: apps */ export async function appsDeleteInstallation( @@ -74041,7 +77772,7 @@ export async function appsDeleteInstallation( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app} * Tags: apps */ export async function appsCreateInstallationAccessToken( @@ -74086,7 +77817,7 @@ export async function appsCreateInstallationAccessToken( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#suspend-an-app-installation} + * Learn more at {@link https://docs.github.com/rest/apps/apps#suspend-an-app-installation} * Tags: apps */ export async function appsSuspendInstallation( @@ -74111,7 +77842,7 @@ export async function appsSuspendInstallation( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation} + * Learn more at {@link https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation} * Tags: apps */ export async function appsUnsuspendInstallation( @@ -74139,7 +77870,7 @@ export async function appsUnsuspendInstallation( * an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the * application will have no access to the user's account and will no longer be listed on [the application authorizations * settings screen within GitHub](https://github.com/settings/applications#authorized). - * Learn more at {@link https://docs.github.com/rest/reference/apps#delete-an-app-authorization} + * Learn more at {@link https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization} * Tags: apps */ export async function appsDeleteAuthorization( @@ -74172,7 +77903,7 @@ export async function appsDeleteAuthorization( * Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this * endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will * return `404 NOT FOUND`. - * Learn more at {@link https://docs.github.com/rest/reference/apps#check-a-token} + * Learn more at {@link https://docs.github.com/rest/apps/oauth-applications#check-a-token} * Tags: apps */ export async function appsCheckToken( @@ -74207,7 +77938,7 @@ export async function appsCheckToken( * Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing * this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will * return `404 NOT FOUND`. - * Learn more at {@link https://docs.github.com/rest/reference/apps#reset-a-token} + * Learn more at {@link https://docs.github.com/rest/apps/oauth-applications#reset-a-token} * Tags: apps */ export async function appsResetToken( @@ -74240,7 +77971,7 @@ export async function appsResetToken( * OAuth authorization. You must use [Basic * Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing * this endpoint, using the application's `client_id` and `client_secret` as the username and password. - * Learn more at {@link https://docs.github.com/rest/reference/apps#delete-an-app-token} + * Learn more at {@link https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token} * Tags: apps */ export async function appsDeleteToken( @@ -74267,9 +77998,8 @@ export async function appsDeleteToken( } /** * Create a scoped access token - * Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server - * access token. You can specify which repositories the token can access and which permissions are granted to the token. - * You must use [Basic + * Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can + * specify which repositories the token can access and which permissions are granted to the token. You must use [Basic * Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing * this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens * will return `404 NOT FOUND`. @@ -74288,21 +78018,21 @@ export async function appsScopeToken( */ access_token: string; /** - * The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. + * The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. * @example "octocat" */ target?: string; /** - * The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. + * The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. * @example 1 */ target_id?: number; /** - * The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. + * The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. */ repositories?: string[]; /** - * The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. + * The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example * [ * 1 @@ -74335,7 +78065,7 @@ export async function appsScopeToken( * [installation access * token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) * to access this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/apps/#get-an-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-an-app} * Tags: apps */ export async function appsGetBySlug( @@ -74355,10 +78085,166 @@ export async function appsGetBySlug( '200': { transforms: { date: [[['ref', $date_Integration]]] } }, }); } +/** + * Get an assignment + * Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the + * GitHub Classroom for the assignment. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#get-an-assignment} + * Tags: classroom + */ +export async function classroomGetAnAssignment( + ctx: r.Context, + params: { + assignment_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/assignments/{assignment_id}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_ClassroomAssignment]]] } }, + }); +} +/** + * List accepted assignments for an assignment + * Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted + * assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment} + * Tags: classroom + */ +export async function classroomListAcceptedAssigmentsForAnAssignment< + FetcherData, +>( + ctx: r.Context, + params: { + assignment_id: number; + page?: number; + per_page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/assignments/{assignment_id}/accepted_assignments', + params, + method: r.HttpMethod.GET, + queryParams: ['page', 'per_page'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { + transforms: { + date: [[['loop'], ['ref', $date_ClassroomAcceptedAssignment]]], + }, + }, + }); +} +/** + * Get assignment grades + * Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of + * the GitHub Classroom for the assignment. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#get-assignment-grades} + * Tags: classroom + */ +export async function classroomGetAssignmentGrades( + ctx: r.Context, + params: { + assignment_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/assignments/{assignment_id}/grades', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * List classrooms + * Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an + * administrator of one or more GitHub Classrooms. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#list-classrooms} + * Tags: classroom + */ +export async function classroomListClassrooms( + ctx: r.Context, + params: { + page?: number; + per_page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/classrooms', + params, + method: r.HttpMethod.GET, + queryParams: ['page', 'per_page'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Get a classroom + * Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an + * administrator of the GitHub Classroom. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#get-a-classroom} + * Tags: classroom + */ +export async function classroomGetAClassroom( + ctx: r.Context, + params: { + classroom_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/classrooms/{classroom_id}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * List assignments for a classroom + * Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an + * administrator of the GitHub Classroom. + * Learn more at {@link https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom} + * Tags: classroom + */ +export async function classroomListAssignmentsForAClassroom( + ctx: r.Context, + params: { + classroom_id: number; + page?: number; + per_page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/classrooms/{classroom_id}/assignments', + params, + method: r.HttpMethod.GET, + queryParams: ['page', 'per_page'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { + transforms: { + date: [[['loop'], ['ref', $date_SimpleClassroomAssignment]]], + }, + }, + }); +} /** * Get all codes of conduct * Returns array of all GitHub's codes of conduct. - * Learn more at {@link https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct} + * Learn more at {@link https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct} * Tags: codes-of-conduct */ export async function codesOfConductGetAllCodesOfConduct( @@ -74377,7 +78263,7 @@ export async function codesOfConductGetAllCodesOfConduct( /** * Get a code of conduct * Returns information about the specified GitHub code of conduct. - * Learn more at {@link https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct} + * Learn more at {@link https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct} * Tags: codes-of-conduct */ export async function codesOfConductGetConductCode( @@ -74398,7 +78284,7 @@ export async function codesOfConductGetConductCode( /** * Get emojis * Lists all the emojis available to use on GitHub. - * Learn more at {@link https://docs.github.com/rest/reference/emojis#get-emojis} + * Learn more at {@link https://docs.github.com/rest/emojis/emojis#get-emojis} * Tags: emojis */ export async function emojisGet( @@ -74487,7 +78373,7 @@ export async function dependabotListAlertsForEnterprise( * scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a * [security * manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise} * Tags: secret-scanning */ export async function secretScanningListAlertsForEnterprise( @@ -74533,7 +78419,7 @@ export async function secretScanningListAlertsForEnterprise( * List public events * We delay the public events feed by five minutes, which means the most recent event returned by the public events API * actually occurred at least five minutes ago. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-public-events} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-public-events} * Tags: activity */ export async function activityListPublicEvents( @@ -74578,7 +78464,7 @@ export async function activityListPublicEvents( * **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. - * Learn more at {@link https://docs.github.com/rest/reference/activity#get-feeds} + * Learn more at {@link https://docs.github.com/rest/activity/feeds#get-feeds} * Tags: activity */ export async function activityGetFeeds( @@ -74597,7 +78483,7 @@ export async function activityGetFeeds( /** * List gists for the authenticated user * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user} * Tags: gists */ export async function gistsList( @@ -74626,7 +78512,7 @@ export async function gistsList( * * **Note:** Don't name your files "gistfile" with a numerical * suffix. This is the format of the automatic naming scheme that Gist uses internally. - * Learn more at {@link https://docs.github.com/rest/reference/gists#create-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#create-a-gist} * Tags: gists */ export async function gistsCreate( @@ -74677,7 +78563,7 @@ export async function gistsCreate( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-public-gists} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-public-gists} * Tags: gists */ export async function gistsListPublic( @@ -74703,7 +78589,7 @@ export async function gistsListPublic( /** * List starred gists * List the authenticated user's starred gists: - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-starred-gists} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-starred-gists} * Tags: gists */ export async function gistsListStarred( @@ -74728,7 +78614,7 @@ export async function gistsListStarred( } /** * Get a gist - * Learn more at {@link https://docs.github.com/rest/reference/gists#get-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#get-a-gist} * Tags: gists */ export async function gistsGet( @@ -74752,7 +78638,9 @@ export async function gistsGet( * Update a gist * Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version * of the gist that aren't explicitly changed during an edit are unchanged. - * Learn more at {@link https://docs.github.com/rest/reference/gists/#update-a-gist} + * At least one of `description` or `files` is + * required. + * Learn more at {@link https://docs.github.com/rest/gists/gists#update-a-gist} * Tags: gists */ export async function gistsUpdate( @@ -74760,7 +78648,39 @@ export async function gistsUpdate( params: { gist_id: string; }, - body: (any | any) | null, + body: { + /** + * The description of the gist. + * @example "Example Ruby script" + */ + description?: string; + /** + * The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + * (including extension) of the targeted gist file. For example: `hello.py`. + * + * To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be + * deleted if the specified object does not contain at least one of `content` or `filename`. + * @example + * { + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } + */ + files?: { + [key: string]: { + /** + * The new content of the file. + */ + content?: string; + /** + * The new filename for the file. + */ + filename?: string | null; + } | null; + }; + } | null, opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ @@ -74776,7 +78696,7 @@ export async function gistsUpdate( } /** * Delete a gist - * Learn more at {@link https://docs.github.com/rest/reference/gists#delete-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#delete-a-gist} * Tags: gists */ export async function gistsDelete( @@ -74796,7 +78716,7 @@ export async function gistsDelete( } /** * List gist comments - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-gist-comments} + * Learn more at {@link https://docs.github.com/rest/gists/comments#list-gist-comments} * Tags: gists */ export async function gistsListComments( @@ -74821,7 +78741,7 @@ export async function gistsListComments( } /** * Create a gist comment - * Learn more at {@link https://docs.github.com/rest/reference/gists#create-a-gist-comment} + * Learn more at {@link https://docs.github.com/rest/gists/comments#create-a-gist-comment} * Tags: gists */ export async function gistsCreateComment( @@ -74851,7 +78771,7 @@ export async function gistsCreateComment( } /** * Get a gist comment - * Learn more at {@link https://docs.github.com/rest/reference/gists#get-a-gist-comment} + * Learn more at {@link https://docs.github.com/rest/gists/comments#get-a-gist-comment} * Tags: gists */ export async function gistsGetComment( @@ -74874,7 +78794,7 @@ export async function gistsGetComment( } /** * Update a gist comment - * Learn more at {@link https://docs.github.com/rest/reference/gists#update-a-gist-comment} + * Learn more at {@link https://docs.github.com/rest/gists/comments#update-a-gist-comment} * Tags: gists */ export async function gistsUpdateComment( @@ -74905,7 +78825,7 @@ export async function gistsUpdateComment( } /** * Delete a gist comment - * Learn more at {@link https://docs.github.com/rest/reference/gists#delete-a-gist-comment} + * Learn more at {@link https://docs.github.com/rest/gists/comments#delete-a-gist-comment} * Tags: gists */ export async function gistsDeleteComment( @@ -74926,7 +78846,7 @@ export async function gistsDeleteComment( } /** * List gist commits - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-gist-commits} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-gist-commits} * Tags: gists */ export async function gistsListCommits( @@ -74951,7 +78871,7 @@ export async function gistsListCommits( } /** * List gist forks - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-gist-forks} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-gist-forks} * Tags: gists */ export async function gistsListForks( @@ -74976,7 +78896,7 @@ export async function gistsListForks( } /** * Fork a gist - * Learn more at {@link https://docs.github.com/rest/reference/gists#fork-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#fork-a-gist} * Tags: gists */ export async function gistsFork( @@ -74998,7 +78918,7 @@ export async function gistsFork( } /** * Check if a gist is starred - * Learn more at {@link https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred} + * Learn more at {@link https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred} * Tags: gists */ export async function gistsCheckIsStarred( @@ -75020,7 +78940,7 @@ export async function gistsCheckIsStarred( * Star a gist * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/gists#star-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#star-a-gist} * Tags: gists */ export async function gistsStar( @@ -75040,7 +78960,7 @@ export async function gistsStar( } /** * Unstar a gist - * Learn more at {@link https://docs.github.com/rest/reference/gists#unstar-a-gist} + * Learn more at {@link https://docs.github.com/rest/gists/gists#unstar-a-gist} * Tags: gists */ export async function gistsUnstar( @@ -75060,7 +78980,7 @@ export async function gistsUnstar( } /** * Get a gist revision - * Learn more at {@link https://docs.github.com/rest/reference/gists#get-a-gist-revision} + * Learn more at {@link https://docs.github.com/rest/gists/gists#get-a-gist-revision} * Tags: gists */ export async function gistsGetRevision( @@ -75084,8 +79004,8 @@ export async function gistsGetRevision( /** * Get all gitignore templates * List all templates available to pass as an option when [creating a - * repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). - * Learn more at {@link https://docs.github.com/rest/reference/gitignore#get-all-gitignore-templates} + * repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * Learn more at {@link https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates} * Tags: gitignore */ export async function gitignoreGetAllTemplates( @@ -75106,7 +79026,7 @@ export async function gitignoreGetAllTemplates( * The API also allows fetching the source of a single template. * Use the raw [media * type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. - * Learn more at {@link https://docs.github.com/rest/reference/gitignore#get-a-gitignore-template} + * Learn more at {@link https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template} * Tags: gitignore */ export async function gitignoreGetTemplate( @@ -75131,7 +79051,7 @@ export async function gitignoreGetTemplate( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation} + * Learn more at {@link https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation} * Tags: apps */ export async function appsListReposAccessibleToInstallation( @@ -75177,13 +79097,13 @@ export async function appsListReposAccessibleToInstallation( * 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. + * app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * - * You must - * use an [installation access + * You must use an + * [installation access * token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) * to access this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token} + * Learn more at {@link https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token} * Tags: apps */ export async function appsRevokeInstallationAccessToken( @@ -75215,8 +79135,8 @@ export async function appsRevokeInstallationAccessToken( * the `pull_request` key. Be aware that the `id` of a pull request returned from * "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull - * requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user} + * requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * Learn more at {@link https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user} * Tags: issues */ export async function issuesList( @@ -75269,7 +79189,9 @@ export async function issuesList( } /** * Get all commonly used licenses - * Learn more at {@link https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses} + * Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository + * ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * Learn more at {@link https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses} * Tags: licenses */ export async function licensesGetAllCommonlyUsed( @@ -75292,7 +79214,9 @@ export async function licensesGetAllCommonlyUsed( } /** * Get a license - * Learn more at {@link https://docs.github.com/rest/reference/licenses#get-a-license} + * Gets information about a specific license. For more information, see "[Licensing a repository + * ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * Learn more at {@link https://docs.github.com/rest/licenses/licenses#get-a-license} * Tags: licenses */ export async function licensesGet( @@ -75312,7 +79236,7 @@ export async function licensesGet( } /** * Render a Markdown document - * Learn more at {@link https://docs.github.com/rest/reference/markdown#render-a-markdown-document} + * Learn more at {@link https://docs.github.com/rest/markdown/markdown#render-a-markdown-document} * Tags: markdown */ export async function markdownRender( @@ -75350,7 +79274,7 @@ export async function markdownRender( * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this * endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not * supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - * Learn more at {@link https://docs.github.com/rest/reference/markdown#render-a-markdown-document-in-raw-mode} + * Learn more at {@link https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode} * Tags: markdown */ export async function markdownRenderRaw( @@ -75376,10 +79300,10 @@ export async function markdownRenderRaw( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account} * Tags: apps */ export async function appsGetSubscriptionPlanForAccount( @@ -75403,10 +79327,10 @@ export async function appsGetSubscriptionPlanForAccount( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-plans} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-plans} * Tags: apps */ export async function appsListPlans( @@ -75435,10 +79359,10 @@ export async function appsListPlans( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan} * Tags: apps */ export async function appsListAccountsForPlan( @@ -75469,10 +79393,10 @@ export async function appsListAccountsForPlan( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed} * Tags: apps */ export async function appsGetSubscriptionPlanForAccountStubbed( @@ -75496,10 +79420,10 @@ export async function appsGetSubscriptionPlanForAccountStubbed( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-plans-stubbed} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-plans-stubbed} * Tags: apps */ export async function appsListPlansStubbed( @@ -75528,10 +79452,10 @@ export async function appsListPlansStubbed( * * 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 + * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed} + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed} * Tags: apps */ export async function appsListAccountsForPlanStubbed( @@ -75568,7 +79492,7 @@ export async function appsListAccountsForPlanStubbed( * **Note:** This endpoint returns both IPv4 and IPv6 addresses. * However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if * IPv6 is supported. - * Learn more at {@link https://docs.github.com/rest/reference/meta#get-github-meta-information} + * Learn more at {@link https://docs.github.com/rest/meta/meta#get-apiname-meta-information} * Tags: meta */ export async function metaGet( @@ -75586,7 +79510,7 @@ export async function metaGet( } /** * List public events for a network of repositories - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories} * Tags: activity */ export async function activityListPublicEventsForRepoNetwork( @@ -75613,7 +79537,7 @@ export async function activityListPublicEventsForRepoNetwork( /** * List notifications for the authenticated user * List all notifications for the current user, sorted by most recently updated. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user} * Tags: activity */ export async function activityListNotificationsForAuthenticatedUser< @@ -75653,9 +79577,9 @@ export async function activityListNotificationsForAuthenticatedUser< * Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one * request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as * "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated - * user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass - * the query parameter `all=false`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#mark-notifications-as-read} + * user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and + * pass the query parameter `all=false`. + * Learn more at {@link https://docs.github.com/rest/activity/notifications#mark-notifications-as-read} * Tags: activity */ export async function activityMarkNotificationsAsRead( @@ -75691,7 +79615,7 @@ export async function activityMarkNotificationsAsRead( /** * Get a thread * Gets information about a notification thread. - * Learn more at {@link https://docs.github.com/rest/reference/activity#get-a-thread} + * Learn more at {@link https://docs.github.com/rest/activity/notifications#get-a-thread} * Tags: activity */ export async function activityGetThread( @@ -75715,7 +79639,7 @@ export async function activityGetThread( * Mark a thread as read * Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox * on GitHub: https://github.com/notifications. - * Learn more at {@link https://docs.github.com/rest/reference/activity#mark-a-thread-as-read} + * Learn more at {@link https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read} * Tags: activity */ export async function activityMarkThreadAsRead( @@ -75736,12 +79660,12 @@ export async function activityMarkThreadAsRead( /** * Get a thread subscription for the authenticated user * 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). + * subscription](https://docs.github.com/rest/activity/watching#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. - * Learn more at {@link https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user} * Tags: activity */ export async function activityGetThreadSubscriptionForAuthenticatedUser< @@ -75774,8 +79698,8 @@ export async function activityGetThreadSubscriptionForAuthenticatedUser< * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/activity#set-a-thread-subscription} + * subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Learn more at {@link https://docs.github.com/rest/activity/notifications#set-a-thread-subscription} * Tags: activity */ export async function activitySetThreadSubscription( @@ -75807,9 +79731,9 @@ export async function activitySetThreadSubscription( * 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`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#delete-a-thread-subscription} + * subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` + * to `true`. + * Learn more at {@link https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription} * Tags: activity */ export async function activityDeleteThreadSubscription( @@ -75830,7 +79754,7 @@ export async function activityDeleteThreadSubscription( /** * Get Octocat * Get the octocat as ASCII art - * Learn more at {@link https://docs.github.com/rest/reference/meta#get-octocat} + * Learn more at {@link https://docs.github.com/rest/meta/meta#get-octocat} * Tags: meta */ export async function metaGetOctocat( @@ -75857,7 +79781,7 @@ export async function metaGetOctocat( * the `since` parameter. Use the [Link * header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the * next page of organizations. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organizations} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-organizations} * Tags: orgs */ export async function orgsList( @@ -75889,7 +79813,7 @@ export async function orgsList( * 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." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#get-an-organization} * Tags: orgs */ export async function orgsGet( @@ -75921,7 +79845,7 @@ export async function orgsGet( * Enables an authenticated * organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member * privileges. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#update-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#update-an-organization} * Tags: orgs */ export async function orgsUpdate( @@ -76101,7 +80025,7 @@ export async function orgsUpdate( * endpoint: * * https://docs.github.com/site-policy/github-terms/github-terms-of-service - * Learn more at {@link https://docs.github.com/rest/orgs/orgs/#delete-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#delete-an-organization} * Tags: orgs */ export async function orgsDelete( @@ -76127,7 +80051,7 @@ export async function orgsDelete( * You * must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the * `organization_admistration:read` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization} * Tags: actions */ export async function actionsGetActionsCacheUsageForOrg( @@ -76153,7 +80077,7 @@ export async function actionsGetActionsCacheUsageForOrg( * updated. * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must * have the `organization_admistration:read` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization} * Tags: actions */ export async function actionsGetActionsCacheUsageByRepoForOrg( @@ -76236,7 +80160,7 @@ export async function oidcUpdateOidcCustomSubTemplateForOrg( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization} * Tags: actions */ export async function actionsGetGithubActionsPermissionsOrganization< @@ -76263,7 +80187,7 @@ export async function actionsGetGithubActionsPermissionsOrganization< * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization} * Tags: actions */ export async function actionsSetGithubActionsPermissionsOrganization< @@ -76297,7 +80221,7 @@ export async function actionsSetGithubActionsPermissionsOrganization< * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization} * Tags: actions */ export async function actionsListSelectedRepositoriesEnabledGithubActionsOrganization< @@ -76340,7 +80264,7 @@ export async function actionsListSelectedRepositoriesEnabledGithubActionsOrganiz * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization} * Tags: actions */ export async function actionsSetSelectedRepositoriesEnabledGithubActionsOrganization< @@ -76377,7 +80301,7 @@ export async function actionsSetSelectedRepositoriesEnabledGithubActionsOrganiza * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization} * Tags: actions */ export async function actionsEnableSelectedRepositoryGithubActionsOrganization< @@ -76408,7 +80332,7 @@ export async function actionsEnableSelectedRepositoryGithubActionsOrganization< * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization} * Tags: actions */ export async function actionsDisableSelectedRepositoryGithubActionsOrganization< @@ -76438,7 +80362,7 @@ export async function actionsDisableSelectedRepositoryGithubActionsOrganization< * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization} * Tags: actions */ export async function actionsGetAllowedActionsOrganization( @@ -76465,7 +80389,7 @@ export async function actionsGetAllowedActionsOrganization( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization} * Tags: actions */ export async function actionsSetAllowedActionsOrganization( @@ -76497,7 +80421,7 @@ export async function actionsSetAllowedActionsOrganization( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-default-workflow-permissions} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization} * Tags: actions */ export async function actionsGetGithubActionsDefaultWorkflowPermissionsOrganization< @@ -76529,7 +80453,7 @@ export async function actionsGetGithubActionsDefaultWorkflowPermissionsOrganizat * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-default-workflow-permissions} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization} * Tags: actions */ export async function actionsSetGithubActionsDefaultWorkflowPermissionsOrganization< @@ -76551,360 +80475,25 @@ export async function actionsSetGithubActionsDefaultWorkflowPermissionsOrganizat const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } -/** - * List required workflows - * List all required workflows in an organization. - * - * You must authenticate using an access token with the `read:org` scope - * to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-required-workflows} - * Tags: actions - */ -export async function actionsListRequiredWorkflows( - ctx: r.Context, - params: { - org: string; - per_page?: number; - page?: number; - }, - opts?: FetcherData, -): Promise<{ - total_count: number; - required_workflows: RequiredWorkflow[]; -}> { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows', - params, - method: r.HttpMethod.GET, - queryParams: ['per_page', 'page'], - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { - transforms: { - date: [ - [ - ['access', 'required_workflows'], - ['loop'], - ['ref', $date_RequiredWorkflow], - ], - ], - }, - }, - }); -} -/** - * Create a required workflow - * Create a required workflow in an organization. - * - * You must authenticate using an access token with the `admin:org` scope - * to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-required-workflow} - * Tags: actions - */ -export async function actionsCreateRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - }, - body: { - /** - * Path of the workflow file to be configured as a required workflow. - */ - workflow_file_path: string; - /** - * The ID of the repository that contains the workflow file. - */ - repository_id: string; - /** - * Enable the required workflow for all repositories or selected repositories in the organization. - * @defaultValue "all" - */ - scope?: 'selected' | 'all'; - /** - * A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`. - */ - selected_repository_ids?: number[]; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows', - params, - method: r.HttpMethod.POST, - body, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '201': { transforms: { date: [[['ref', $date_RequiredWorkflow]]] } }, - }); -} -/** - * Get a required workflow - * Get a required workflow configured in an organization. - * - * You must authenticate using an access token with the `read:org` - * scope to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-required-workflow} - * Tags: actions - */ -export async function actionsGetRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}', - params, - method: r.HttpMethod.GET, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { transforms: { date: [[['ref', $date_RequiredWorkflow]]] } }, - }); -} -/** - * Update a required workflow - * Update a required workflow in an organization. - * - * You must authenticate using an access token with the `admin:org` scope - * to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#update-a-required-workflow} - * Tags: actions - */ -export async function actionsUpdateRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - }, - body: { - /** - * Path of the workflow file to be configured as a required workflow. - */ - workflow_file_path?: string; - /** - * The ID of the repository that contains the workflow file. - */ - repository_id?: string; - /** - * Enable the required workflow for all repositories or selected repositories in the organization. - * @defaultValue "all" - */ - scope?: 'selected' | 'all'; - /** - * A list of repository IDs where you want to enable the required workflow. A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`. - */ - selected_repository_ids?: number[]; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}', - params, - method: r.HttpMethod.PATCH, - body, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { transforms: { date: [[['ref', $date_RequiredWorkflow]]] } }, - }); -} -/** - * Delete a required workflow - * Deletes a required workflow configured in an organization. - * - * You must authenticate using an access token with the - * `admin:org` scope to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-a-required-workflow} - * Tags: actions - */ -export async function actionsDeleteRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}', - params, - method: r.HttpMethod.DELETE, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} -/** - * List selected repositories for a required workflow - * Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, - * the required workflow must be configured to run on selected repositories. - * - * You must authenticate using an access token - * with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to - * use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-selected-repositories-required-workflows} - * Tags: actions - */ -export async function actionsListSelectedRepositoriesRequiredWorkflow< - FetcherData, ->( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - }, - opts?: FetcherData, -): Promise<{ - total_count: number; - repositories: Repository[]; -}> { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories', - params, - method: r.HttpMethod.GET, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { - transforms: { - date: [ - [['access', 'repositories'], ['loop'], ['ref', $date_Repository]], - ], - }, - }, - }); -} -/** - * Sets repositories for a required workflow - * Sets the repositories for a required workflow that is required for selected repositories. - * - * You must authenticate using - * an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-selected-repositories-for-a-required-workflow} - * Tags: actions - */ -export async function actionsSetSelectedReposToRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - }, - body: { - /** - * The IDs of the repositories for which the workflow should be required. - */ - selected_repository_ids: number[]; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories', - params, - method: r.HttpMethod.PUT, - body, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} -/** - * Add a repository to a required workflow - * Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on - * selected repositories. - * - * You must authenticate using an access token with the `admin:org` scope to use this - * endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#add-a-repository-to-selected-repositories-list-for-a-required-workflow} - * Tags: actions - */ -export async function actionsAddSelectedRepoToRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - repository_id: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}', - params, - method: r.HttpMethod.PUT, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} -/** - * Remove a selected repository from required workflow - * Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on - * selected repositories. - * - * You must authenticate using an access token with the `admin:org` scope to use this - * endpoint. - * - * For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-a-repository-from-selected-repositories-list-for-a-required-workflow} - * Tags: actions - */ -export async function actionsRemoveSelectedRepoFromRequiredWorkflow< - FetcherData, ->( - ctx: r.Context, - params: { - org: string; - required_workflow_id: number; - repository_id: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}', - params, - method: r.HttpMethod.DELETE, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} /** * List self-hosted runners for an organization * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization} + * If the repository is private, you must use an access token with the `repo` + * scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` + * permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization} * Tags: actions */ export async function actionsListSelfHostedRunnersForOrg( ctx: r.Context, params: { + name?: string; org: string; per_page?: number; page?: number; @@ -76918,7 +80507,7 @@ export async function actionsListSelfHostedRunnersForOrg( path: '/orgs/{org}/actions/runners', params, method: r.HttpMethod.GET, - queryParams: ['per_page', 'page'], + queryParams: ['name', 'per_page', 'page'], }); const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); @@ -76929,7 +80518,13 @@ export async function actionsListSelfHostedRunnersForOrg( * * You must authenticate using an access token * with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization} + * If the repository is private, you must use an access token with the + * `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization} * Tags: actions */ export async function actionsListRunnerApplicationsForOrg( @@ -76953,6 +80548,12 @@ export async function actionsListRunnerApplicationsForOrg( * * You must authenticate using an * access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token + * with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization} * Tags: actions */ @@ -77003,17 +80604,23 @@ export async function actionsGenerateRunnerJitconfigForOrg( * * You must authenticate using * an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access + * token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these + * endpoints. * - * #### Example using registration token + * Example using registration token: * - * Configure your - * self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the + * registration token provided by this endpoint. * * ``` - * ./config.sh --url - * https://github.com/octo-org --token TOKEN + * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization} * Tags: actions */ export async function actionsCreateRegistrationTokenForOrg( @@ -77038,19 +80645,26 @@ export async function actionsCreateRegistrationTokenForOrg( * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token * expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this - * endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If + * the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the + * `administration` permission for repositories and the `organization_self_hosted_runners` permission for + * organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * #### Example using remove token + * Example using remove token: * - * To remove your self-hosted runner from an organization, replace `TOKEN` with - * the remove token provided by this + * To remove your + * self-hosted runner from an organization, replace `TOKEN` with the remove token provided by + * this * endpoint. * * ``` * ./config.sh remove --token TOKEN * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization} * Tags: actions */ export async function actionsCreateRemoveTokenForOrg( @@ -77076,7 +80690,13 @@ export async function actionsCreateRemoveTokenForOrg( * * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization} + * If the repository is private, you must use an access token with the `repo` + * scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` + * permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsGetSelfHostedRunnerForOrg( @@ -77102,7 +80722,13 @@ export async function actionsGetSelfHostedRunnerForOrg( * * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization} + * If the repository is private, you must use an access token with the `repo` + * scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` + * permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization} * Tags: actions */ export async function actionsDeleteSelfHostedRunnerFromOrg( @@ -77127,7 +80753,13 @@ export async function actionsDeleteSelfHostedRunnerFromOrg( * * You must authenticate using an access token * with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization} + * If the repository is private, you must use an access token with the + * `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsListLabelsForSelfHostedRunnerForOrg( @@ -77155,7 +80787,13 @@ export async function actionsListLabelsForSelfHostedRunnerForOrg( * * You must authenticate using an access token * with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization} + * If the repository is private, you must use an access token with the + * `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsAddCustomLabelsToSelfHostedRunnerForOrg< @@ -77193,7 +80831,14 @@ export async function actionsAddCustomLabelsToSelfHostedRunnerForOrg< * organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization} + * If the + * repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` + * permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users + * must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to + * use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsSetCustomLabelsForSelfHostedRunnerForOrg< @@ -77231,7 +80876,14 @@ export async function actionsSetCustomLabelsForSelfHostedRunnerForOrg< * from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization} + * If the + * repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` + * permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users + * must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to + * use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrg< @@ -77266,7 +80918,13 @@ export async function actionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrg< * * You must * authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization} + * If the repository is private, you + * must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories + * and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization} * Tags: actions */ export async function actionsRemoveCustomLabelFromSelfHostedRunnerForOrg< @@ -77293,10 +80951,17 @@ export async function actionsRemoveCustomLabelFromSelfHostedRunnerForOrg< } /** * List organization secrets - * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an - * access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization - * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-organization-secrets} + * Lists all secrets available in an organization without revealing their + * encrypted values. + * + * You must authenticate using an + * access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token + * with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated + * users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#list-organization-secrets} * Tags: actions */ export async function actionsListOrgSecrets( @@ -77334,10 +80999,18 @@ export async function actionsListOrgSecrets( } /** * Get an organization public key - * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update - * secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must - * have the `secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-an-organization-public-key} + * Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update + * secrets. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository + * is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization + * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-an-organization-public-key} * Tags: actions */ export async function actionsGetOrgPublicKey( @@ -77357,10 +81030,16 @@ export async function actionsGetOrgPublicKey( } /** * Get an organization secret - * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token - * with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-an-organization-secret} + * Gets a single organization secret without revealing its encrypted value. + * + * You must authenticate using an access token + * with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the + * `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must + * have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-an-organization-secret} * Tags: actions */ export async function actionsGetOrgSecret( @@ -77387,104 +81066,17 @@ export async function actionsGetOrgSecret( * Create or update an organization secret * Creates or updates an organization secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization - * permission to - * use this endpoint. - * - * **Example encrypting a secret using Node.js* - * - * Encrypt your secret using the - * [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link 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. + * If the repository is private, you + * must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret} * Tags: actions */ export async function actionsCreateOrUpdateOrgSecret( @@ -77495,7 +81087,7 @@ export async function actionsCreateOrUpdateOrgSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; /** @@ -77507,7 +81099,7 @@ export async function actionsCreateOrUpdateOrgSecret( */ visibility: 'all' | 'private' | 'selected'; /** - * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids?: number[]; }, @@ -77524,10 +81116,16 @@ export async function actionsCreateOrUpdateOrgSecret( } /** * Delete an organization secret - * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the - * `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-an-organization-secret} + * Deletes a secret in an organization using the secret name. + * + * You must authenticate using an access token with the + * `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` + * scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have + * collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#delete-an-organization-secret} * Tags: actions */ export async function actionsDeleteOrgSecret( @@ -77548,10 +81146,18 @@ export async function actionsDeleteOrgSecret( } /** * List selected repositories for an organization secret - * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to - * `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps - * must have the `secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret} + * Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to + * `selected`. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the + * repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` + * organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to + * create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret} * Tags: actions */ export async function actionsListSelectedReposForOrgSecret( @@ -77590,12 +81196,20 @@ export async function actionsListSelectedReposForOrgSecret( } /** * Set selected repositories for an organization secret - * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. - * The visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate - * using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization - * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret} + * Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. + * The visibility is set when you [Create + * or update an organization + * secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate + * using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an + * access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret} * Tags: actions */ export async function actionsSetSelectedReposForOrgSecret( @@ -77606,7 +81220,7 @@ export async function actionsSetSelectedReposForOrgSecret( }, body: { /** - * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }, @@ -77623,12 +81237,20 @@ export async function actionsSetSelectedReposForOrgSecret( } /** * Add selected repository to an organization secret - * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret} + * 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/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate + * using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an + * access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret} * Tags: actions */ export async function actionsAddSelectedRepoToOrgSecret( @@ -77650,12 +81272,20 @@ export async function actionsAddSelectedRepoToOrgSecret( } /** * Remove selected repository from an organization secret - * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The - * visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate - * using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization - * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret} + * Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The + * visibility is set when you [Create + * or update an organization + * secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate + * using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an + * access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret} * Tags: actions */ export async function actionsRemoveSelectedRepoFromOrgSecret( @@ -77677,8 +81307,11 @@ export async function actionsRemoveSelectedRepoFromOrgSecret( } /** * List organization variables - * Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this - * endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Lists all organization variables. + * You must authenticate using an access token with the `admin:org` scope to use this + * endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the + * `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have + * collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#list-organization-variables} * Tags: actions */ @@ -77718,10 +81351,14 @@ export async function actionsListOrgVariables( /** * Create an organization variable * Creates an organization variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an * access token with the `admin:org` scope to use this endpoint. - * GitHub Apps must have the - * `organization_actions_variables:write` organization permission to use this endpoint. + * If the repository is private, you must use an access token + * with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use + * this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#create-an-organization-variable} * Tags: actions */ @@ -77761,9 +81398,15 @@ export async function actionsCreateOrgVariable( } /** * Get an organization variable - * Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to - * use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this - * endpoint. + * Gets a specific variable in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to + * use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must + * have the `organization_actions_variables:read` organization permission to use this endpoint. + * Authenticated users must + * have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#get-an-organization-variable} * Tags: actions */ @@ -77790,10 +81433,14 @@ export async function actionsGetOrgVariable( /** * Update an organization variable * Updates an organization variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an * access token with the `admin:org` scope to use this endpoint. - * GitHub Apps must have the - * `organization_actions_variables:write` organization permission to use this endpoint. + * If the repository is private, you must use an access token + * with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use + * this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#update-an-organization-variable} * Tags: actions */ @@ -77835,10 +81482,14 @@ export async function actionsUpdateOrgVariable( /** * Delete an organization variable * Deletes an organization variable using the variable name. + * * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * GitHub Apps must have the `organization_actions_variables:write` organization - * permission to use this endpoint. + * If the repository is private, you must use an access token with the `repo` + * scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#delete-an-organization-variable} * Tags: actions */ @@ -77860,9 +81511,17 @@ export async function actionsDeleteOrgVariable( } /** * List selected repositories for an organization variable - * Lists all repositories that can access an organization variable that is available to selected repositories. You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `organization_actions_variables:read` organization permission to use this endpoint. + * Lists all repositories that can access an organization variable + * that is available to selected repositories. + * + * You must + * authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you + * must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:read` + * organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to + * create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable} * Tags: actions */ @@ -77902,10 +81561,20 @@ export async function actionsListSelectedReposForOrgVariable( } /** * Set selected repositories for an organization variable - * Replaces all repositories for an organization variable that is available to selected repositories. Organization - * variables that are available to selected repositories have their `visibility` field set to `selected`. You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `organization_actions_variables:write` organization permission to use this endpoint. + * Replaces all repositories for an organization variable that is available + * to selected repositories. Organization + * variables that are available to selected + * repositories have their `visibility` field set to `selected`. + * + * You must + * authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you + * must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` + * organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to + * create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable} * Tags: actions */ @@ -77934,10 +81603,17 @@ export async function actionsSetSelectedReposForOrgVariable( } /** * Add selected repository to an organization variable - * Adds a repository to an organization variable that is available to selected repositories. Organization variables that - * are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an - * access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `organization_actions_variables:write` organization permission to use this endpoint. + * Adds a repository to an organization variable that is available to selected repositories. + * Organization variables that + * are available to selected repositories have their `visibility` field set to `selected`. + * + * You must authenticate using an + * access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token + * with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use + * this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable} * Tags: actions */ @@ -77960,10 +81636,19 @@ export async function actionsAddSelectedRepoToOrgVariable( } /** * Remove selected repository from an organization variable - * Removes a repository from an organization variable that is available to selected repositories. Organization variables - * that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using - * an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `organization_actions_variables:write` organization permission to use this endpoint. + * Removes a repository from an organization variable that is + * available to selected repositories. Organization variables + * that are available to + * selected repositories have their `visibility` field set to `selected`. + * + * You must authenticate + * using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an + * access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization + * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable} * Tags: actions */ @@ -77987,7 +81672,7 @@ export async function actionsRemoveSelectedRepoFromOrgVariable( /** * List users blocked by an organization * List the users blocked by an organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization} * Tags: orgs */ export async function orgsListBlockedUsers( @@ -78012,7 +81697,7 @@ export async function orgsListBlockedUsers( * Check if a user is blocked by an organization * Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking * the user, or if the user account has been identified as spam by GitHub. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization} * Tags: orgs */ export async function orgsCheckBlockedUser( @@ -78035,7 +81720,7 @@ export async function orgsCheckBlockedUser( * Block a user from an organization * Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the * given user a 422 is returned. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization} * Tags: orgs */ export async function orgsBlockUser( @@ -78057,7 +81742,7 @@ export async function orgsBlockUser( /** * Unblock a user from an organization * Unblocks the given user on behalf of the specified organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization} * Tags: orgs */ export async function orgsUnblockUser( @@ -78091,7 +81776,7 @@ export async function orgsUnblockUser( * scope. * * GitHub Apps must have the `security_events` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization} * Tags: code-scanning */ export async function codeScanningListAlertsForOrg( @@ -78105,7 +81790,7 @@ export async function codeScanningListAlertsForOrg( page?: number; per_page?: number; direction?: 'asc' | 'desc'; - state?: CodeScanningAlertState; + state?: CodeScanningAlertStateQuery; sort?: 'created' | 'updated'; severity?: CodeScanningAlertSeverity; }, @@ -78143,7 +81828,7 @@ export async function codeScanningListAlertsForOrg( * * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-in-organization} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization} * Tags: codespaces */ export async function codespacesListInOrganization( @@ -78179,14 +81864,14 @@ export async function codespacesListInOrganization( /** * Manage access control for organization codespaces * Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces - * billing permissions for users according to the visibility. + * access permissions for users according to the visibility. * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#set-codespaces-billing} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces} * Tags: codespaces */ -export async function codespacesSetCodespacesBilling( +export async function codespacesSetCodespacesAccess( ctx: r.Context, params: { org: string; @@ -78208,7 +81893,7 @@ export async function codespacesSetCodespacesBilling( opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ - path: '/orgs/{org}/codespaces/billing', + path: '/orgs/{org}/codespaces/access', params, method: r.HttpMethod.PUT, body, @@ -78217,17 +81902,22 @@ export async function codespacesSetCodespacesBilling( return ctx.handleResponse(res, {}); } /** - * Add users to Codespaces billing for an organization + * Add users to Codespaces access for an organization * Codespaces for the specified users will be billed to the organization. - * To use this endpoint, the billing settings for - * the organization must be set to `selected_members`. For information on how to change this setting please see [these - * docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * To use this endpoint, the access settings for + * the organization must be set to `selected_members`. + * For information on how to change this setting, see "[Manage access + * control for organization + * codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * + * You + * must authenticate using an access token with the `admin:org` scope to use this endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#set-codespaces-billing-users} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization} * Tags: codespaces */ -export async function codespacesSetCodespacesBillingUsers( +export async function codespacesSetCodespacesAccessUsers( ctx: r.Context, params: { org: string; @@ -78241,7 +81931,7 @@ export async function codespacesSetCodespacesBillingUsers( opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ - path: '/orgs/{org}/codespaces/billing/selected_users', + path: '/orgs/{org}/codespaces/access/selected_users', params, method: r.HttpMethod.POST, body, @@ -78250,18 +81940,22 @@ export async function codespacesSetCodespacesBillingUsers( return ctx.handleResponse(res, {}); } /** - * Removes users from Codespaces billing for an organization + * Remove users from Codespaces access for an organization * Codespaces for the specified users will no longer be billed to the organization. - * To use this endpoint, the billing - * settings for the organization must be set to `selected_members`. For information on how to change this setting please - * see [these - * docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * To use this endpoint, the access + * settings for the organization must be set to `selected_members`. + * For information on how to change this setting, see + * "[Manage access control for organization + * codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * + * You + * must authenticate using an access token with the `admin:org` scope to use this endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#delete-codespaces-billing-users} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization} * Tags: codespaces */ -export async function codespacesDeleteCodespacesBillingUsers( +export async function codespacesDeleteCodespacesAccessUsers( ctx: r.Context, params: { org: string; @@ -78275,7 +81969,7 @@ export async function codespacesDeleteCodespacesBillingUsers( opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ - path: '/orgs/{org}/codespaces/billing/selected_users', + path: '/orgs/{org}/codespaces/access/selected_users', params, method: r.HttpMethod.DELETE, body, @@ -78288,7 +81982,7 @@ export async function codespacesDeleteCodespacesBillingUsers( * Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. * You must * authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-organization-secrets} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets} * Tags: codespaces */ export async function codespacesListOrgSecrets( @@ -78325,7 +82019,7 @@ export async function codespacesListOrgSecrets( * Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a * secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope * to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key} * Tags: codespaces */ export async function codespacesGetOrgPublicKey( @@ -78348,7 +82042,7 @@ export async function codespacesGetOrgPublicKey( * Gets an organization secret without revealing its encrypted value. * You must authenticate using an access token with the * `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret} * Tags: codespaces */ export async function codespacesGetOrgSecret( @@ -78373,102 +82067,13 @@ export async function codespacesGetOrgSecret( * Create or update an organization secret * Creates or updates an organization secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `admin:org` scope to use this endpoint. - * - * **Example encrypting a secret using Node.js** + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Encrypt - * your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium - * = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret} + * You must + * authenticate using an access + * token with the `admin:org` scope to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret} * Tags: codespaces */ export async function codespacesCreateOrUpdateOrgSecret( @@ -78479,7 +82084,7 @@ export async function codespacesCreateOrUpdateOrgSecret( }, body: { /** - * The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key) endpoint. + * The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; /** @@ -78491,7 +82096,7 @@ export async function codespacesCreateOrUpdateOrgSecret( */ visibility: 'all' | 'private' | 'selected'; /** - * An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids?: number[]; }, @@ -78510,7 +82115,7 @@ export async function codespacesCreateOrUpdateOrgSecret( * Delete an organization secret * Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` * scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#delete-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret} * Tags: codespaces */ export async function codespacesDeleteOrgSecret( @@ -78533,7 +82138,7 @@ export async function codespacesDeleteOrgSecret( * List selected repositories for an organization secret * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to * `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret} * Tags: codespaces */ export async function codespacesListSelectedReposForOrgSecret( @@ -78574,9 +82179,9 @@ export async function codespacesListSelectedReposForOrgSecret( * Set selected repositories for an organization secret * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. * The visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must + * secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must * authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret} * Tags: codespaces */ export async function codespacesSetSelectedReposForOrgSecret( @@ -78587,7 +82192,7 @@ export async function codespacesSetSelectedReposForOrgSecret( }, body: { /** - * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }, @@ -78606,9 +82211,9 @@ export async function codespacesSetSelectedReposForOrgSecret( * Add selected repository to an organization secret * 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/codespaces#create-or-update-an-organization-secret). You must + * secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must * authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#add-selected-repository-to-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret} * Tags: codespaces */ export async function codespacesAddSelectedRepoToOrgSecret( @@ -78632,9 +82237,9 @@ export async function codespacesAddSelectedRepoToOrgSecret( * Remove selected repository from an organization secret * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The * visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must + * secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must * authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret} * Tags: codespaces */ export async function codespacesRemoveSelectedRepoFromOrgSecret( @@ -78654,6 +82259,286 @@ export async function codespacesRemoveSelectedRepoFromOrgSecret( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * Get Copilot for Business seat information and settings for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Gets information about an organization's Copilot for + * Business subscription, including seat breakdown + * and code matching policies. To configure these settings, go to your + * organization's settings on GitHub.com. + * For more information, see "[Configuring GitHub Copilot settings in your + * organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * + * Only + * organization owners and members with admin permissions can configure and view details about the organization's Copilot + * for Business subscription. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use + * this endpoint. + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization} + * Tags: copilot + */ +export async function copilotGetCopilotOrganizationDetails( + ctx: r.Context, + params: { + org: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * List all Copilot for Business seat assignments for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Lists all Copilot for Business seat assignments for an + * organization that are currently being billed (either active or pending cancellation at the start of the next billing + * cycle). + * + * Only organization owners and members with admin permissions can configure and view details about the + * organization's Copilot for Business subscription. You must + * authenticate using an access token with the + * `manage_billing:copilot` scope to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization} + * Tags: copilot + */ +export async function copilotListCopilotSeats( + ctx: r.Context, + params: { + org: string; + page?: number; + per_page?: number; + }, + opts?: FetcherData, +): Promise<{ + /** + * Total number of Copilot For Business seats for the organization currently being billed. + */ + total_seats?: number; + seats?: CopilotSeatDetails[]; +}> { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing/seats', + params, + method: r.HttpMethod.GET, + queryParams: ['page', 'per_page'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { + transforms: { + date: [ + [['access', 'seats'], ['loop'], ['ref', $date_CopilotSeatDetails]], + ], + }, + }, + }); +} +/** + * Add teams to the Copilot for Business subscription for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Purchases a GitHub Copilot for Business seat for all + * users within each specified team. + * The organization will be billed accordingly. For more information about Copilot for + * Business pricing, see "[About billing for GitHub Copilot for + * Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You + * must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * + * In order for an + * admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion + * matching policy. + * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot + * for Business subscription for your + * organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for + * GitHub Copilot in your + * organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization} + * Tags: copilot + */ +export async function copilotAddCopilotForBusinessSeatsForTeams( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * List of team names within the organization to which to grant access to GitHub Copilot. + */ + selected_teams: string[]; + }, + opts?: FetcherData, +): Promise<{ + seats_created: number; +}> { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing/selected_teams', + params, + method: r.HttpMethod.POST, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Remove teams from the Copilot for Business subscription for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Cancels the Copilot for Business seat assignment for all + * members of each team specified. + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at + * the end of the current billing cycle, and the organization will not be billed further for those users. + * + * For more + * information about Copilot for Business pricing, see "[About billing for GitHub Copilot for + * Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * + * For + * more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific + * users in your + * organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * + * Only + * organization owners and members with admin permissions can configure GitHub Copilot in their organization. You + * must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization} + * Tags: copilot + */ +export async function copilotCancelCopilotSeatAssignmentForTeams( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * The names of teams from which to revoke access to GitHub Copilot. + */ + selected_teams: string[]; + }, + opts?: FetcherData, +): Promise<{ + seats_cancelled: number; +}> { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing/selected_teams', + params, + method: r.HttpMethod.DELETE, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Add users to the Copilot for Business subscription for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Purchases a GitHub Copilot for Business seat for each user + * specified. + * The organization will be billed accordingly. For more information about Copilot for Business pricing, see + * "[About billing for GitHub Copilot for + * Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * + * Only + * organization owners and members with admin permissions can configure GitHub Copilot in their organization. You + * must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * + * In order for an + * admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion + * matching policy. + * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot + * for Business subscription for your + * organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". + * For + * more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub + * Copilot in your + * organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization} + * Tags: copilot + */ +export async function copilotAddCopilotForBusinessSeatsForUsers( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * The usernames of the organization members to be granted access to GitHub Copilot. + */ + selected_usernames: string[]; + }, + opts?: FetcherData, +): Promise<{ + seats_created: number; +}> { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing/selected_users', + params, + method: r.HttpMethod.POST, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Remove users from the Copilot for Business subscription for an organization + * **Note**: This endpoint is in beta and is subject to change. + * + * Cancels the Copilot for Business seat assignment for each + * user specified. + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing + * cycle, and the organization will not be billed further for those users. + * + * For more information about Copilot for Business + * pricing, see "[About billing for GitHub Copilot for + * Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * + * For + * more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific + * users in your + * organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * + * Only + * organization owners and members with admin permissions can configure GitHub Copilot in their organization. You + * must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization} + * Tags: copilot + */ +export async function copilotCancelCopilotSeatAssignmentForUsers( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * The usernames of the organization members for which to revoke access to GitHub Copilot. + */ + selected_usernames: string[]; + }, + opts?: FetcherData, +): Promise<{ + seats_cancelled: number; +}> { + const req = await ctx.createRequest({ + path: '/orgs/{org}/copilot/billing/selected_users', + params, + method: r.HttpMethod.DELETE, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List Dependabot alerts for an organization * Lists Dependabot alerts for an organization. @@ -78721,7 +82606,7 @@ export async function dependabotListAlertsForOrg( * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an * access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` * organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#list-organization-secrets} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#list-organization-secrets} * Tags: dependabot */ export async function dependabotListOrgSecrets( @@ -78762,7 +82647,7 @@ export async function dependabotListOrgSecrets( * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update * secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must * have the `dependabot_secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key} * Tags: dependabot */ export async function dependabotGetOrgPublicKey( @@ -78785,7 +82670,7 @@ export async function dependabotGetOrgPublicKey( * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token * with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission * to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#get-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret} * Tags: dependabot */ export async function dependabotGetOrgSecret( @@ -78812,104 +82697,15 @@ export async function dependabotGetOrgSecret( * Create or update an organization secret * Creates or updates an organization secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - * organization - * permission to use this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using - * the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret} + * You must + * authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the + * `dependabot_secrets` organization + * permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret} * Tags: dependabot */ export async function dependabotCreateOrUpdateOrgSecret( @@ -78920,7 +82716,7 @@ export async function dependabotCreateOrUpdateOrgSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; /** @@ -78932,7 +82728,7 @@ export async function dependabotCreateOrUpdateOrgSecret( */ visibility: 'all' | 'private' | 'selected'; /** - * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids?: string[]; }, @@ -78952,7 +82748,7 @@ export async function dependabotCreateOrUpdateOrgSecret( * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the * `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use * this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret} * Tags: dependabot */ export async function dependabotDeleteOrgSecret( @@ -78976,7 +82772,7 @@ export async function dependabotDeleteOrgSecret( * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to * `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps * must have the `dependabot_secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret} * Tags: dependabot */ export async function dependabotListSelectedReposForOrgSecret( @@ -79017,10 +82813,10 @@ export async function dependabotListSelectedReposForOrgSecret( * Set selected repositories for an organization secret * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. * The visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `dependabot_secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret} + * secret](https://docs.github.com/rest/dependabot/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 `dependabot_secrets` + * organization permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret} * Tags: dependabot */ export async function dependabotSetSelectedReposForOrgSecret( @@ -79031,7 +82827,7 @@ export async function dependabotSetSelectedReposForOrgSecret( }, body: { /** - * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }, @@ -79050,10 +82846,10 @@ export async function dependabotSetSelectedReposForOrgSecret( * Add selected repository to an organization secret * 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/dependabot#create-or-update-an-organization-secret). You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `dependabot_secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret} + * secret](https://docs.github.com/rest/dependabot/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 `dependabot_secrets` + * organization permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret} * Tags: dependabot */ export async function dependabotAddSelectedRepoToOrgSecret( @@ -79077,10 +82873,10 @@ export async function dependabotAddSelectedRepoToOrgSecret( * Remove selected repository from an organization secret * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The * visibility is set when you [Create or update an organization - * secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must - * authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the - * `dependabot_secrets` organization permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret} + * secret](https://docs.github.com/rest/dependabot/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 `dependabot_secrets` + * organization permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret} * Tags: dependabot */ export async function dependabotRemoveSelectedRepoFromOrgSecret( @@ -79106,7 +82902,7 @@ export async function dependabotRemoveSelectedRepoFromOrgSecret( * conflict during a Docker migration. * To use this endpoint, you must authenticate using an access token with the * `read:packages` scope. - * Learn more at {@link https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization} * Tags: packages */ export async function packagesListDockerMigrationConflictingPackagesForOrganization< @@ -79130,7 +82926,7 @@ export async function packagesListDockerMigrationConflictingPackagesForOrganizat } /** * List public organization events - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-public-organization-events} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-public-organization-events} * Tags: activity */ export async function activityListPublicOrgEvents( @@ -79157,7 +82953,7 @@ export async function activityListPublicOrgEvents( * List failed organization invitations * The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed * and the reason for the failure. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-failed-organization-invitations} * Tags: orgs */ export async function orgsListFailedInvitations( @@ -79180,7 +82976,7 @@ export async function orgsListFailedInvitations( } /** * List organization webhooks - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organization-webhooks} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks} * Tags: orgs */ export async function orgsListWebhooks( @@ -79206,7 +83002,7 @@ export async function orgsListWebhooks( /** * Create an organization webhook * Here's how you can create a hook that posts payloads in JSON format: - * Learn more at {@link https://docs.github.com/rest/reference/orgs#create-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook} * Tags: orgs */ export async function orgsCreateWebhook( @@ -79220,7 +83016,7 @@ export async function orgsCreateWebhook( */ name: string; /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). + * Key/value pairs to provide settings for this webhook. */ config: { url: WebhookConfigUrl; @@ -79266,8 +83062,8 @@ export async function orgsCreateWebhook( /** * Get an organization webhook * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-an-organization-webhook} + * configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook} * Tags: orgs */ export async function orgsGetWebhook( @@ -79293,8 +83089,8 @@ export async function orgsGetWebhook( * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#update-an-organization-webhook} + * organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook} * Tags: orgs */ export async function orgsUpdateWebhook( @@ -79305,7 +83101,7 @@ export async function orgsUpdateWebhook( }, body: { /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). + * Key/value pairs to provide settings for this webhook. */ config?: { url: WebhookConfigUrl; @@ -79346,7 +83142,7 @@ export async function orgsUpdateWebhook( } /** * Delete an organization webhook - * Learn more at {@link https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook} * Tags: orgs */ export async function orgsDeleteWebhook( @@ -79368,11 +83164,11 @@ export async function orgsDeleteWebhook( /** * Get a webhook configuration for an organization * 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)." + * state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * * Access * tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-a-webhook-configuration-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization} * Tags: orgs */ export async function orgsGetWebhookConfigForOrg( @@ -79395,11 +83191,11 @@ export async function orgsGetWebhookConfigForOrg( * Update a webhook configuration for an organization * 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)." + * ](/rest/orgs/webhooks#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub * Apps must have the `organization_hooks:write` permission. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#update-a-webhook-configuration-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization} * Tags: orgs */ export async function orgsUpdateWebhookConfigForOrg( @@ -79428,7 +83224,7 @@ export async function orgsUpdateWebhookConfigForOrg( /** * List deliveries for an organization webhook * Returns a list of webhook deliveries for a webhook configured in an organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook} * Tags: orgs */ export async function orgsListWebhookDeliveries( @@ -79458,7 +83254,7 @@ export async function orgsListWebhookDeliveries( /** * Get a webhook delivery for an organization webhook * Returns a delivery for a webhook configured in an organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook} * Tags: orgs */ export async function orgsGetWebhookDelivery( @@ -79483,7 +83279,7 @@ export async function orgsGetWebhookDelivery( /** * Redeliver a delivery for an organization webhook * Redeliver a delivery for a webhook configured in an organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook} * Tags: orgs */ export async function orgsRedeliverWebhookDelivery( @@ -79506,7 +83302,7 @@ export async function orgsRedeliverWebhookDelivery( /** * Ping an organization webhook * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook} + * Learn more at {@link https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook} * Tags: orgs */ export async function orgsPingWebhook( @@ -79532,7 +83328,7 @@ export async function orgsPingWebhook( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app} * Tags: apps */ export async function appsGetOrgInstallation( @@ -79556,7 +83352,7 @@ export async function appsGetOrgInstallation( * List app installations for an organization * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in * the organization. You must be an organization owner with `admin:read` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization} * Tags: orgs */ export async function orgsListAppInstallations( @@ -79592,7 +83388,7 @@ export async function orgsListAppInstallations( * Get interaction restrictions for an organization * Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no * restrictions, you will see an empty response. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization} * Tags: interactions */ export async function interactionsGetRestrictionsForOrg( @@ -79621,7 +83417,7 @@ export async function interactionsGetRestrictionsForOrg( * Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. * You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level * will overwrite any interaction limits that are set for individual repositories owned by the organization. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization} * Tags: interactions */ export async function interactionsSetRestrictionsForOrg( @@ -79649,7 +83445,7 @@ export async function interactionsSetRestrictionsForOrg( * Remove interaction restrictions for an organization * Removes all interaction restrictions from public repositories in the given organization. You must be an organization * owner to remove restrictions. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization} * Tags: interactions */ export async function interactionsRemoveRestrictionsForOrg( @@ -79672,7 +83468,7 @@ export async function interactionsRemoveRestrictionsForOrg( * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the * following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub * member, the `login` field in the return hash will be `null`. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-pending-organization-invitations} * Tags: orgs */ export async function orgsListPendingInvitations( @@ -79712,7 +83508,7 @@ export async function orgsListPendingInvitations( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#create-an-organization-invitation} + * Learn more at {@link https://docs.github.com/rest/orgs/members#create-an-organization-invitation} * Tags: orgs */ export async function orgsCreateInvitation( @@ -79760,7 +83556,7 @@ export async function orgsCreateInvitation( * * This endpoint triggers * [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Learn more at {@link https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation} + * Learn more at {@link https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation} * Tags: orgs */ export async function orgsCancelInvitation( @@ -79783,7 +83579,7 @@ export async function orgsCancelInvitation( * List organization invitation teams * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user * must be an organization owner. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-organization-invitation-teams} * Tags: orgs */ export async function orgsListInvitationTeams( @@ -79816,8 +83612,8 @@ export async function orgsListInvitationTeams( * the `pull_request` key. Be aware that the `id` of a * pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List - * pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user} + * pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * Learn more at {@link https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user} * Tags: issues */ export async function issuesListForOrg( @@ -79865,7 +83661,7 @@ export async function issuesListForOrg( * List organization members * List all users who are members of an organization. If the authenticated user is also a member of this organization then * both concealed and public members will be returned. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organization-members} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-organization-members} * Tags: orgs */ export async function orgsListMembers( @@ -79891,7 +83687,7 @@ export async function orgsListMembers( /** * Check organization membership for a user * Check if a user is, publicly or privately, a member of the organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user} * Tags: orgs */ export async function orgsCheckMembershipForUser( @@ -79914,7 +83710,7 @@ export async function orgsCheckMembershipForUser( * Remove an organization member * Removing a user from this list will remove them from all teams and they will no longer have any access to the * organization's repositories. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#remove-an-organization-member} + * Learn more at {@link https://docs.github.com/rest/orgs/members#remove-an-organization-member} * Tags: orgs */ export async function orgsRemoveMember( @@ -79939,7 +83735,7 @@ export async function orgsRemoveMember( * * You must authenticate * using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-codespaces-for-user-in-org} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization} * Tags: codespaces */ export async function codespacesGetCodespacesForUserInOrg( @@ -79979,7 +83775,7 @@ export async function codespacesGetCodespacesForUserInOrg( * * You must authenticate using an access token with the `admin:org` scope to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization} * Tags: codespaces */ export async function codespacesDeleteFromOrganization( @@ -80004,7 +83800,7 @@ export async function codespacesDeleteFromOrganization( * Stops a user's codespace. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces} + * Learn more at {@link https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user} * Tags: codespaces */ export async function codespacesStopInOrganization( @@ -80026,11 +83822,42 @@ export async function codespacesStopInOrganization( '200': { transforms: { date: [[['ref', $date_Codespace]]] } }, }); } +/** + * Get Copilot for Business seat assignment details for a user + * **Note**: This endpoint is in beta and is subject to change. + * + * Gets the GitHub Copilot for Business seat assignment + * details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners and members + * with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user} + * Tags: copilot + */ +export async function copilotGetCopilotSeatDetailsForUser( + ctx: r.Context, + params: { + org: string; + username: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/members/{username}/copilot', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_CopilotSeatDetails]]] } }, + }); +} /** * Get organization membership for a user * In order to get a user's membership with an organization, the authenticated user must be an organization member. The * `state` parameter in the response can be used to identify the user's membership status. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user} * Tags: orgs */ export async function orgsGetMembershipForUser( @@ -80056,7 +83883,7 @@ export async function orgsGetMembershipForUser( * * 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 + * status](https://docs.github.com/rest/orgs/members#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 @@ -80069,7 +83896,7 @@ export async function orgsGetMembershipForUser( * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour * period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour * period. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user} * Tags: orgs */ export async function orgsSetMembershipForUser( @@ -80106,7 +83933,7 @@ export async function orgsSetMembershipForUser( * the specified user is an active member of the organization, this will remove them from the organization. If the * specified user has been invited to the organization, this will cancel their invitation. The specified user will receive * an email notification in both cases. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user} * Tags: orgs */ export async function orgsRemoveMembershipForUser( @@ -80205,7 +84032,7 @@ export async function migrationsStartForOrg( */ org_metadata_only?: boolean; /** - * Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. + * Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: 'repositories'[]; }, @@ -80358,7 +84185,7 @@ export async function migrationsListReposForOrg( /** * List outside collaborators for an organization * List all users who are outside collaborators of an organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization} * Tags: orgs */ export async function orgsListOutsideCollaborators( @@ -80389,7 +84216,7 @@ export async function orgsListOutsideCollaborators( * Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more * information, see "[Enforcing repository management policies in your * enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator} + * Learn more at {@link https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator} * Tags: orgs */ export async function orgsConvertMemberToOutsideCollaborator( @@ -80418,7 +84245,7 @@ export async function orgsConvertMemberToOutsideCollaborator( /** * Remove outside collaborator from an organization * Removing a user from this list will remove them from all the organization's repositories. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization} + * Learn more at {@link https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization} * Tags: orgs */ export async function orgsRemoveOutsideCollaborator( @@ -80446,7 +84273,7 @@ export async function orgsRemoveOutsideCollaborator( * permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support * repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#list-packages-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-packages-for-an-organization} * Tags: packages */ export async function packagesListPackagesForOrganization( @@ -80486,7 +84313,7 @@ export async function packagesListPackagesForOrganization( * permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support * repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization} * Tags: packages */ export async function packagesGetPackageForOrganization( @@ -80530,7 +84357,7 @@ export async function packagesGetPackageForOrganization( * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin * permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization} * Tags: packages */ export async function packagesDeletePackageForOrg( @@ -80578,7 +84405,7 @@ export async function packagesDeletePackageForOrg( * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin * permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization} * Tags: packages */ export async function packagesRestorePackageForOrg( @@ -80614,7 +84441,7 @@ export async function packagesRestorePackageForOrg( * registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list * of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization} * Tags: packages */ export async function packagesGetAllPackageVersionsForPackageOwnedByOrg< @@ -80659,7 +84486,7 @@ export async function packagesGetAllPackageVersionsForPackageOwnedByOrg< * permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support * repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization} * Tags: packages */ export async function packagesGetPackageVersionForOrganization( @@ -80705,7 +84532,7 @@ export async function packagesGetPackageVersionForOrganization( * permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions * for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization} * Tags: packages */ export async function packagesDeletePackageVersionForOrg( @@ -80755,7 +84582,7 @@ export async function packagesDeletePackageVersionForOrg( * permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions * for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization} * Tags: packages */ export async function packagesRestorePackageVersionForOrg( @@ -80790,7 +84617,7 @@ export async function packagesRestorePackageVersionForOrg( * * **Note**: * Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens} * Tags: orgs */ export async function orgsListPatGrantRequests( @@ -80837,7 +84664,7 @@ export async function orgsListPatGrantRequests( * * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to * change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens} * Tags: orgs */ export async function orgsReviewPatGrantRequestsInBulk( @@ -80878,7 +84705,7 @@ export async function orgsReviewPatGrantRequestsInBulk( * * **Note**: * Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token} * Tags: orgs */ export async function orgsReviewPatGrantRequest( @@ -80916,7 +84743,7 @@ export async function orgsReviewPatGrantRequest( * * **Note**: Fine-grained PATs are in * public beta. Related APIs, events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token} * Tags: orgs */ export async function orgsListPatGrantRequestRepositories( @@ -80950,7 +84777,7 @@ export async function orgsListPatGrantRequestRepositories( * * **Note**: * Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources} * Tags: orgs */ export async function orgsListPatGrants( @@ -80997,7 +84824,7 @@ export async function orgsListPatGrants( * * **Note**: Fine-grained PATs are in public beta. Related APIs, * events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens} * Tags: orgs */ export async function orgsUpdatePatAccesses( @@ -81035,7 +84862,7 @@ export async function orgsUpdatePatAccesses( * * **Note**: Fine-grained PATs are in * public beta. Related APIs, events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources} * Tags: orgs */ export async function orgsUpdatePatAccess( @@ -81069,7 +84896,7 @@ export async function orgsUpdatePatAccess( * * **Note**: Fine-grained PATs are in public beta. Related APIs, * events, and functionality are subject to change. - * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to} + * Learn more at {@link https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to} * Tags: orgs */ export async function orgsListPatGrantRepositories( @@ -81099,7 +84926,7 @@ export async function orgsListPatGrantRepositories( * List organization projects * Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If * you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-organization-projects} + * Learn more at {@link https://docs.github.com/rest/projects/projects#list-organization-projects} * Tags: projects */ export async function projectsListForOrg( @@ -81128,7 +84955,7 @@ export async function projectsListForOrg( * Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if * the organization does not have existing classic projects. If you do not have sufficient privileges to perform this * action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#create-an-organization-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#create-an-organization-project} * Tags: projects */ export async function projectsCreateForOrg( @@ -81159,10 +84986,227 @@ export async function projectsCreateForOrg( '201': { transforms: { date: [[['ref', $date_Project]]] } }, }); } +/** + * Get all custom properties for an organization + * Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/orgs/properties#get-all-custom-properties-for-an-organization} + * Tags: orgs + */ +export async function orgsGetAllCustomProperties( + ctx: r.Context, + params: { + org: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/schema', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Create or update custom properties for an organization + * Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or + * users with the proper permissions granted by them) can update these properties + * Learn more at {@link https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-for-an-organization} + * Tags: orgs + */ +export async function orgsCreateOrUpdateCustomProperties( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * The array of custom properties to create or update. + */ + properties: OrgCustomProperty[]; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/schema', + params, + method: r.HttpMethod.PATCH, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Get a custom property for an organization + * Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/orgs/properties#get-a-custom-property-for-an-organization} + * Tags: orgs + */ +export async function orgsGetCustomProperty( + ctx: r.Context, + params: { + org: string; + custom_property_name: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/schema/{custom_property_name}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Create or update a custom property for an organization + * Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization + * owner to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-for-an-organization} + * Tags: orgs + */ +export async function orgsCreateOrUpdateCustomProperty( + ctx: r.Context, + params: { + org: string; + custom_property_name: string; + }, + body: { + /** + * The type of the value for the property + * @example "single_select" + */ + value_type: 'string' | 'single_select'; + /** + * Whether the property is required. + */ + required?: boolean; + /** + * Default value of the property + */ + default_value?: string | null; + /** + * Short description of the property + */ + description?: string | null; + /** + * Ordered list of allowed values of the property + */ + allowed_values?: string[] | null; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/schema/{custom_property_name}', + params, + method: r.HttpMethod.PUT, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Remove a custom property for an organization + * Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization} + * Tags: orgs + */ +export async function orgsRemoveCustomProperty( + ctx: r.Context, + params: { + org: string; + custom_property_name: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/schema/{custom_property_name}', + params, + method: r.HttpMethod.DELETE, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * List custom property values for organization repositories + * Lists organization repositories with all of their custom property values. + * Organization members can read these + * properties. + * Learn more at {@link https://docs.github.com/rest/orgs/properties#list-custom-property-values-for-organization-repositories} + * Tags: orgs + */ +export async function orgsListCustomPropertiesValuesForRepos( + ctx: r.Context, + params: { + org: string; + per_page?: number; + page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/values', + params, + method: r.HttpMethod.GET, + queryParams: ['per_page', 'page'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Create or update custom property values for organization repositories + * Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each + * target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum + * of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or + * 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted + * by them) can update these properties + * Learn more at {@link https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories} + * Tags: orgs + */ +export async function orgsCreateOrUpdateCustomPropertiesValuesForRepos< + FetcherData, +>( + ctx: r.Context, + params: { + org: string; + }, + body: { + /** + * The names of repositories that the custom property values will be applied to. + */ + repository_names: string[]; + /** + * List of custom property names and associated values to apply to the repositories. + */ + properties: CustomPropertyValue[]; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/properties/values', + params, + method: r.HttpMethod.PATCH, + body, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List public organization members * Members of an organization can choose to have their membership publicized or not. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-public-organization-members} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-public-organization-members} * Tags: orgs */ export async function orgsListPublicMembers( @@ -81186,7 +85230,7 @@ export async function orgsListPublicMembers( /** * Check public organization membership for a user * Check if the provided user is a public member of the organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user} * Tags: orgs */ export async function orgsCheckPublicMembershipForUser( @@ -81212,7 +85256,7 @@ export async function orgsCheckPublicMembershipForUser( * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user} * Tags: orgs */ export async function orgsSetPublicMembershipForAuthenticatedUser( @@ -81235,7 +85279,7 @@ export async function orgsSetPublicMembershipForAuthenticatedUser( * Remove public organization membership for the authenticated user * Removes the public membership for the authenticated user from the specified organization, unless public visibility is * enforced by default. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user} * Tags: orgs */ export async function orgsRemovePublicMembershipForAuthenticatedUser< @@ -81264,7 +85308,7 @@ export async function orgsRemovePublicMembershipForAuthenticatedUser< * repository you must have admin permissions for the repository or be an owner or security manager for the organization * that owns the repository. For more information, see "[Managing security managers in your * organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-organization-repositories} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-organization-repositories} * Tags: repos */ export async function reposListForOrg( @@ -81306,7 +85350,7 @@ export async function reposListForOrg( * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope * to create an internal repository. * * `repo` scope to create a private repository - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-an-organization-repository} + * Learn more at {@link https://docs.github.com/rest/repos/repos#create-an-organization-repository} * Tags: repos */ export async function reposCreateInOrg( @@ -81451,7 +85495,7 @@ export async function reposCreateInOrg( /** * Get all organization repository rulesets * Get all the repository rulesets for an organization. - * Learn more at {@link https://docs.github.com/rest/repos/rules#get-organization-rulesets} + * Learn more at {@link https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets} * Tags: repos */ export async function reposGetOrgRulesets( @@ -81479,7 +85523,7 @@ export async function reposGetOrgRulesets( /** * Create an organization repository ruleset * Create a repository ruleset for an organization. - * Learn more at {@link https://docs.github.com/rest/repos/rules#create-organization-repository-ruleset} + * Learn more at {@link https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset} * Tags: repos */ export async function reposCreateOrgRuleset( @@ -81520,10 +85564,77 @@ export async function reposCreateOrgRuleset( '201': { transforms: { date: [[['ref', $date_RepositoryRuleset]]] } }, }); } +/** + * List organization rule suites + * Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for + * repositories in your + * organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * Learn more at {@link https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites} + * Tags: repos + */ +export async function reposGetOrgRuleSuites( + ctx: r.Context, + params: { + org: string; + repository_name?: number; + time_period?: 'hour' | 'day' | 'week' | 'month'; + actor_name?: string; + rule_suite_result?: 'pass' | 'fail' | 'bypass' | 'all'; + per_page?: number; + page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/rulesets/rule-suites', + params, + method: r.HttpMethod.GET, + queryParams: [ + 'repository_name', + 'time_period', + 'actor_name', + 'rule_suite_result', + 'per_page', + 'page', + ], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_RuleSuites]]] } }, + }); +} +/** + * Get an organization rule suite + * Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing + * rulesets for repositories in your + * organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * Learn more at {@link https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite} + * Tags: repos + */ +export async function reposGetOrgRuleSuite( + ctx: r.Context, + params: { + org: string; + rule_suite_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/rulesets/rule-suites/{rule_suite_id}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_RuleSuite]]] } }, + }); +} /** * Get an organization repository ruleset * Get a repository ruleset for an organization. - * Learn more at {@link https://docs.github.com/rest/repos/rules#get-organization-ruleset} + * Learn more at {@link https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset} * Tags: repos */ export async function reposGetOrgRuleset( @@ -81547,7 +85658,7 @@ export async function reposGetOrgRuleset( /** * Update an organization repository ruleset * Update a ruleset for an organization. - * Learn more at {@link https://docs.github.com/rest/repos/rules#update-organization-ruleset} + * Learn more at {@link https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset} * Tags: repos */ export async function reposUpdateOrgRuleset( @@ -81592,7 +85703,7 @@ export async function reposUpdateOrgRuleset( /** * Delete an organization repository ruleset * Delete a ruleset for an organization. - * Learn more at {@link https://docs.github.com/rest/repos/rules#delete-organization-ruleset} + * Learn more at {@link https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset} * Tags: repos */ export async function reposDeleteOrgRuleset( @@ -81621,7 +85732,7 @@ export async function reposDeleteOrgRuleset( * * GitHub Apps * must have the `secret_scanning_alerts` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization} * Tags: secret-scanning */ export async function secretScanningListAlertsForOrg( @@ -81665,6 +85776,44 @@ export async function secretScanningListAlertsForOrg( }, }); } +/** + * List repository security advisories for an organization + * Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security + * manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` + * permission. + * Learn more at {@link https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization} + * Tags: security-advisories + */ +export async function securityAdvisoriesListOrgRepositoryAdvisories< + FetcherData, +>( + ctx: r.Context, + params: { + org: string; + direction?: 'asc' | 'desc'; + sort?: 'created' | 'updated' | 'published'; + before?: string; + after?: string; + per_page?: number; + state?: 'triage' | 'draft' | 'published' | 'closed'; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/orgs/{org}/security-advisories', + params, + method: r.HttpMethod.GET, + queryParams: ['direction', 'sort', 'before', 'after', 'per_page', 'state'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { + transforms: { date: [[['loop'], ['ref', $date_RepositoryAdvisory]]] }, + }, + }); +} /** * List security manager teams * Lists teams that are security managers for an organization. For more information, see "[Managing security managers in @@ -81677,7 +85826,7 @@ export async function secretScanningListAlertsForOrg( * * GitHub Apps must have the `administration` organization read permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-security-manager-teams} + * Learn more at {@link https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams} * Tags: orgs */ export async function orgsListSecurityManagerTeams( @@ -81706,7 +85855,7 @@ export async function orgsListSecurityManagerTeams( * * GitHub Apps must have the `administration` organization read-write permission * to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#add-a-security-manager-team} + * Learn more at {@link https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team} * Tags: orgs */ export async function orgsAddSecurityManagerTeam( @@ -81737,7 +85886,7 @@ export async function orgsAddSecurityManagerTeam( * * GitHub Apps must have the `administration` organization read-write * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#remove-a-security-manager-team} + * Learn more at {@link https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team} * Tags: orgs */ export async function orgsRemoveSecurityManagerTeam( @@ -81768,7 +85917,7 @@ export async function orgsRemoveSecurityManagerTeam( * * Access * tokens must have the `repo` or `admin:org` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization} * Tags: billing */ export async function billingGetGithubActionsBillingOrg( @@ -81796,7 +85945,7 @@ export async function billingGetGithubActionsBillingOrg( * * Access * tokens must have the `repo` or `admin:org` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization} * Tags: billing */ export async function billingGetGithubPackagesBillingOrg( @@ -81824,7 +85973,7 @@ export async function billingGetGithubPackagesBillingOrg( * * Access * tokens must have the `repo` or `admin:org` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization} * Tags: billing */ export async function billingGetSharedStorageBillingOrg( @@ -81845,7 +85994,7 @@ export async function billingGetSharedStorageBillingOrg( /** * List teams * Lists all teams in an organization that are visible to the authenticated user. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-teams} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-teams} * Tags: teams */ export async function teamsList( @@ -81877,7 +86026,7 @@ export async function teamsList( * a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of * `maintainers`. For more information, see "[About * teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". - * Learn more at {@link https://docs.github.com/rest/reference/teams#create-a-team} + * Learn more at {@link https://docs.github.com/rest/teams/teams#create-a-team} * Tags: teams */ export async function teamsCreate( @@ -81951,7 +86100,7 @@ export async function teamsCreate( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET * /organizations/{org_id}/team/{team_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-a-team-by-name} + * Learn more at {@link https://docs.github.com/rest/teams/teams#get-a-team-by-name} * Tags: teams */ export async function teamsGetByName( @@ -81978,7 +86127,7 @@ export async function teamsGetByName( * * **Note:** You can * also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#update-a-team} + * Learn more at {@link https://docs.github.com/rest/teams/teams#update-a-team} * Tags: teams */ export async function teamsUpdateInOrg( @@ -82044,7 +86193,7 @@ export async function teamsUpdateInOrg( * * **Note:** You can also specify a team by * `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#delete-a-team} + * Learn more at {@link https://docs.github.com/rest/teams/teams#delete-a-team} * Tags: teams */ export async function teamsDeleteInOrg( @@ -82070,7 +86219,7 @@ export async function teamsDeleteInOrg( * * **Note:** You can also * specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-discussions} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#list-discussions} * Tags: teams */ export async function teamsListDiscussionsInOrg( @@ -82113,7 +86262,7 @@ export async function teamsListDiscussionsInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST * /organizations/{org_id}/team/{team_id}/discussions`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#create-a-discussion} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#create-a-discussion} * Tags: teams */ export async function teamsCreateDiscussionInOrg( @@ -82157,7 +86306,7 @@ export async function teamsCreateDiscussionInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-a-discussion} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#get-a-discussion} * Tags: teams */ export async function teamsGetDiscussionInOrg( @@ -82188,7 +86337,7 @@ export async function teamsGetDiscussionInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#update-a-discussion} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#update-a-discussion} * Tags: teams */ export async function teamsUpdateDiscussionInOrg( @@ -82229,7 +86378,7 @@ export async function teamsUpdateDiscussionInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#delete-a-discussion} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#delete-a-discussion} * Tags: teams */ export async function teamsDeleteDiscussionInOrg( @@ -82257,7 +86406,7 @@ export async function teamsDeleteDiscussionInOrg( * **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`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-discussion-comments} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments} * Tags: teams */ export async function teamsListDiscussionCommentsInOrg( @@ -82300,7 +86449,7 @@ export async function teamsListDiscussionCommentsInOrg( * * **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`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#create-a-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment} * Tags: teams */ export async function teamsCreateDiscussionCommentInOrg( @@ -82337,7 +86486,7 @@ export async function teamsCreateDiscussionCommentInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-a-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment} * Tags: teams */ export async function teamsGetDiscussionCommentInOrg( @@ -82368,7 +86517,7 @@ export async function teamsGetDiscussionCommentInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#update-a-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment} * Tags: teams */ export async function teamsUpdateDiscussionCommentInOrg( @@ -82406,7 +86555,7 @@ export async function teamsUpdateDiscussionCommentInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#delete-a-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment} * Tags: teams */ export async function teamsDeleteDiscussionCommentInOrg( @@ -82429,14 +86578,15 @@ export async function teamsDeleteDiscussionCommentInOrg( } /** * List reactions for a team discussion comment - * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). - * OAuth access tokens require the `read:discussion` + * List the reactions to a [team discussion + * comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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`. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment} * Tags: reactions */ export async function reactionsListForTeamDiscussionCommentInOrg( @@ -82473,15 +86623,15 @@ export async function reactionsListForTeamDiscussionCommentInOrg( } /** * Create reaction for a 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 an HTTP - * `200` status 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/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require + * the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A + * response with an HTTP `200` status means that you already added the reaction type to this team discussion + * comment. * - * **Note:** You can also - * specify a team by `org_id` and `team_id` using the route `POST + * **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`. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment} * Tags: reactions */ export async function reactionsCreateForTeamDiscussionCommentInOrg( @@ -82494,7 +86644,7 @@ export async function reactionsCreateForTeamDiscussionCommentInOrg( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. */ content: | '+1' @@ -82526,10 +86676,10 @@ export async function reactionsCreateForTeamDiscussionCommentInOrg( * /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete - * a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth - * access tokens require the `write:discussion` - * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction} + * a reaction to a [team discussion + * comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require + * the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction} * Tags: reactions */ export async function reactionsDeleteForTeamDiscussionComment( @@ -82553,14 +86703,14 @@ export async function reactionsDeleteForTeamDiscussionComment( } /** * List reactions for a team discussion - * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens - * require the `read:discussion` + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion} * Tags: reactions */ export async function reactionsListForTeamDiscussionInOrg( @@ -82596,15 +86746,15 @@ export async function reactionsListForTeamDiscussionInOrg( } /** * Create reaction for a team discussion - * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens - * require the `write:discussion` + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access + * tokens require the `write:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP * `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a * team by `org_id` and `team_id` using the route `POST * /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion} * Tags: reactions */ export async function reactionsCreateForTeamDiscussionInOrg( @@ -82616,7 +86766,7 @@ export async function reactionsCreateForTeamDiscussionInOrg( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. */ content: | '+1' @@ -82648,9 +86798,9 @@ export async function reactionsCreateForTeamDiscussionInOrg( * /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a - * [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the + * [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the * `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction} * Tags: reactions */ export async function reactionsDeleteForTeamDiscussion( @@ -82679,7 +86829,7 @@ export async function reactionsDeleteForTeamDiscussion( * * **Note:** You can also specify a team by `org_id` * and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-pending-team-invitations} + * Learn more at {@link https://docs.github.com/rest/teams/members#list-pending-team-invitations} * Tags: teams */ export async function teamsListPendingInvitationsInOrg( @@ -82707,7 +86857,7 @@ export async function teamsListPendingInvitationsInOrg( * * To list members in a team, the team must be visible to the * authenticated user. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-team-members} + * Learn more at {@link https://docs.github.com/rest/teams/members#list-team-members} * Tags: teams */ export async function teamsListMembersInOrg( @@ -82745,8 +86895,8 @@ export async function teamsListMembersInOrg( * membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information - * about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user} + * about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + * Learn more at {@link https://docs.github.com/rest/teams/members#get-team-membership-for-a-user} * Tags: teams */ export async function teamsGetMembershipForUserInOrg( @@ -82795,7 +86945,7 @@ export async function teamsGetMembershipForUserInOrg( * **Note:** You can also * specify a team by `org_id` and `team_id` using the route `PUT * /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user} * Tags: teams */ export async function teamsAddOrUpdateMembershipForUserInOrg( @@ -82844,7 +86994,7 @@ export async function teamsAddOrUpdateMembershipForUserInOrg( * **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}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user} + * Learn more at {@link https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user} * Tags: teams */ export async function teamsRemoveMembershipForUserInOrg( @@ -82870,7 +87020,7 @@ export async function teamsRemoveMembershipForUserInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the * route `GET /organizations/{org_id}/team/{team_id}/projects`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-team-projects} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-team-projects} * Tags: teams */ export async function teamsListProjectsInOrg( @@ -82899,7 +87049,7 @@ export async function teamsListProjectsInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route * `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project} + * Learn more at {@link https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project} * Tags: teams */ export async function teamsCheckPermissionsForProjectInOrg( @@ -82927,7 +87077,7 @@ export async function teamsCheckPermissionsForProjectInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT * /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions} + * Learn more at {@link https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions} * Tags: teams */ export async function teamsAddOrUpdateProjectPermissionsInOrg( @@ -82963,7 +87113,7 @@ export async function teamsAddOrUpdateProjectPermissionsInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE * /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team} + * Learn more at {@link https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team} * Tags: teams */ export async function teamsRemoveProjectInOrg( @@ -82989,7 +87139,7 @@ export async function teamsRemoveProjectInOrg( * * **Note:** You can also specify a team by `org_id` and * `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-team-repositories} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-team-repositories} * Tags: teams */ export async function teamsListReposInOrg( @@ -83030,7 +87180,7 @@ export async function teamsListReposInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET * /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository} * Tags: teams */ export async function teamsCheckPermissionsForRepoInOrg( @@ -83069,7 +87219,7 @@ export async function teamsCheckPermissionsForRepoInOrg( * For more information about the permission levels, see * "[Repository permission levels for an * organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - * Learn more at {@link https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions} + * Learn more at {@link https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions} * Tags: teams */ export async function teamsAddOrUpdateRepoPermissionsInOrg( @@ -83107,7 +87257,7 @@ export async function teamsAddOrUpdateRepoPermissionsInOrg( * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE * /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - * Learn more at {@link https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team} + * Learn more at {@link https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team} * Tags: teams */ export async function teamsRemoveRepoInOrg( @@ -83134,7 +87284,7 @@ export async function teamsRemoveRepoInOrg( * * **Note:** You can also specify a team by `org_id` and * `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-child-teams} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-child-teams} * Tags: teams */ export async function teamsListChildInOrg( @@ -83170,7 +87320,7 @@ export async function teamsListChildInOrg( * * For more information, see "[Managing security managers in your * organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * Learn more at {@link https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization} * Tags: orgs */ export async function orgsEnableOrDisableSecurityProductOnAllOrgRepos< @@ -83189,12 +87339,14 @@ export async function orgsEnableOrDisableSecurityProductOnAllOrgRepos< | 'secret_scanning_push_protection'; enablement: 'enable_all' | 'disable_all'; }, + body: any, opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ path: '/orgs/{org}/{security_product}/{enablement}', params, method: r.HttpMethod.POST, + body, }); const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); @@ -83202,7 +87354,7 @@ export async function orgsEnableOrDisableSecurityProductOnAllOrgRepos< /** * Get a project card * Gets information about a project card. - * Learn more at {@link https://docs.github.com/rest/reference/projects#get-a-project-card} + * Learn more at {@link https://docs.github.com/rest/projects/cards#get-a-project-card} * Tags: projects */ export async function projectsGetCard( @@ -83224,7 +87376,7 @@ export async function projectsGetCard( } /** * Update an existing project card - * Learn more at {@link https://docs.github.com/rest/reference/projects#update-a-project-card} + * Learn more at {@link https://docs.github.com/rest/projects/cards#update-an-existing-project-card} * Tags: projects */ export async function projectsUpdateCard( @@ -83259,7 +87411,7 @@ export async function projectsUpdateCard( /** * Delete a project card * Deletes a project card - * Learn more at {@link https://docs.github.com/rest/reference/projects#delete-a-project-card} + * Learn more at {@link https://docs.github.com/rest/projects/cards#delete-a-project-card} * Tags: projects */ export async function projectsDeleteCard( @@ -83279,7 +87431,7 @@ export async function projectsDeleteCard( } /** * Move a project card - * Learn more at {@link https://docs.github.com/rest/reference/projects#move-a-project-card} + * Learn more at {@link https://docs.github.com/rest/projects/cards#move-a-project-card} * Tags: projects */ export async function projectsMoveCard( @@ -83313,7 +87465,7 @@ export async function projectsMoveCard( /** * Get a project column * Gets information about a project column. - * Learn more at {@link https://docs.github.com/rest/reference/projects#get-a-project-column} + * Learn more at {@link https://docs.github.com/rest/projects/columns#get-a-project-column} * Tags: projects */ export async function projectsGetColumn( @@ -83335,7 +87487,7 @@ export async function projectsGetColumn( } /** * Update an existing project column - * Learn more at {@link https://docs.github.com/rest/reference/projects#update-a-project-column} + * Learn more at {@link https://docs.github.com/rest/projects/columns#update-an-existing-project-column} * Tags: projects */ export async function projectsUpdateColumn( @@ -83366,7 +87518,7 @@ export async function projectsUpdateColumn( /** * Delete a project column * Deletes a project column. - * Learn more at {@link https://docs.github.com/rest/reference/projects#delete-a-project-column} + * Learn more at {@link https://docs.github.com/rest/projects/columns#delete-a-project-column} * Tags: projects */ export async function projectsDeleteColumn( @@ -83387,7 +87539,7 @@ export async function projectsDeleteColumn( /** * List project cards * Lists the project cards in a project. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-project-cards} + * Learn more at {@link https://docs.github.com/rest/projects/cards#list-project-cards} * Tags: projects */ export async function projectsListCards( @@ -83413,7 +87565,7 @@ export async function projectsListCards( } /** * Create a project card - * Learn more at {@link https://docs.github.com/rest/reference/projects#create-a-project-card} + * Learn more at {@link https://docs.github.com/rest/projects/cards#create-a-project-card} * Tags: projects */ export async function projectsCreateCard( @@ -83456,7 +87608,7 @@ export async function projectsCreateCard( } /** * Move a project column - * Learn more at {@link https://docs.github.com/rest/reference/projects#move-a-project-column} + * Learn more at {@link https://docs.github.com/rest/projects/columns#move-a-project-column} * Tags: projects */ export async function projectsMoveColumn( @@ -83486,7 +87638,7 @@ export async function projectsMoveColumn( * Get a project * Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient * privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#get-a-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#get-a-project} * Tags: projects */ export async function projectsGet( @@ -83510,7 +87662,7 @@ export async function projectsGet( * Update a project * Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have * sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#update-a-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#update-a-project} * Tags: projects */ export async function projectsUpdate( @@ -83559,7 +87711,7 @@ export async function projectsUpdate( /** * Delete a project * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - * Learn more at {@link https://docs.github.com/rest/reference/projects#delete-a-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#delete-a-project} * Tags: projects */ export async function projectsDelete( @@ -83583,7 +87735,7 @@ export async function projectsDelete( * collaborators, organization members that are direct collaborators, organization members with access through team * memberships, organization members with access through default organization permissions, and organization owners. You * must be an organization owner or a project `admin` to list collaborators. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-project-collaborators} + * Learn more at {@link https://docs.github.com/rest/projects/collaborators#list-project-collaborators} * Tags: projects */ export async function projectsListCollaborators( @@ -83609,7 +87761,7 @@ export async function projectsListCollaborators( * Add project collaborator * Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a * project `admin` to add a collaborator. - * Learn more at {@link https://docs.github.com/rest/reference/projects#add-project-collaborator} + * Learn more at {@link https://docs.github.com/rest/projects/collaborators#add-project-collaborator} * Tags: projects */ export async function projectsAddCollaborator( @@ -83641,7 +87793,7 @@ export async function projectsAddCollaborator( * Remove user as a collaborator * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a * collaborator. - * Learn more at {@link https://docs.github.com/rest/reference/projects#remove-project-collaborator} + * Learn more at {@link https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator} * Tags: projects */ export async function projectsRemoveCollaborator( @@ -83665,7 +87817,7 @@ export async function projectsRemoveCollaborator( * Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: * `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission * level. - * Learn more at {@link https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user} + * Learn more at {@link https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user} * Tags: projects */ export async function projectsGetPermissionForUser( @@ -83687,7 +87839,7 @@ export async function projectsGetPermissionForUser( /** * List project columns * Lists the project columns in a project. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-project-columns} + * Learn more at {@link https://docs.github.com/rest/projects/columns#list-project-columns} * Tags: projects */ export async function projectsListColumns( @@ -83713,7 +87865,7 @@ export async function projectsListColumns( /** * Create a project column * Creates a new project column. - * Learn more at {@link https://docs.github.com/rest/reference/projects#create-a-project-column} + * Learn more at {@link https://docs.github.com/rest/projects/columns#create-a-project-column} * Tags: projects */ export async function projectsCreateColumn( @@ -83745,10 +87897,43 @@ export async function projectsCreateColumn( * Get rate limit status for the authenticated user * **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * **Note:** The `rate` object is - * deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of - * the `rate` object. The `core` object contains the same information that is present in the `rate` object. - * Learn more at {@link https://docs.github.com/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user} + * Some categories of endpoints have + * custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the + * API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The + * `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` + * object provides your rate limit status for the REST API for searching (excluding code searches). For more information, + * see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the + * REST API for searching code. For more information, see "[Search + * code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status + * for the GraphQL API. For more information, see "[Resource + * limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` + * object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, + * see "[Creating a GitHub App from a + * manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For + * more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` + * object provides your rate limit status for uploading SARIF results to code scanning. For more information, see + * "[Uploading a SARIF file to + * GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub + * Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. + * For more information about API versions, see "[API + * Versions](https://docs.github.com/rest/overview/api-versions)." + * + * **Note:** The `rate` object is deprecated. If you're + * writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. + * The `core` object contains the same information that is present in the `rate` object. + * Learn more at {@link https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user} * Tags: rate-limit */ export async function rateLimitGet( @@ -83764,111 +87949,6 @@ export async function rateLimitGet( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } -/** - * List repository required workflows - * Lists the required workflows in a repository. Anyone with read access to the repository can use this endpoint. If the - * repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - * permission to use this endpoint. For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-repository-required-workflows} - * Tags: actions - */ -export async function actionsListRepoRequiredWorkflows( - ctx: r.Context, - params: { - org: string; - repo: string; - per_page?: number; - page?: number; - }, - opts?: FetcherData, -): Promise<{ - total_count: number; - required_workflows: RepoRequiredWorkflow[]; -}> { - const req = await ctx.createRequest({ - path: '/repos/{org}/{repo}/actions/required_workflows', - params, - method: r.HttpMethod.GET, - queryParams: ['per_page', 'page'], - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { - transforms: { - date: [ - [ - ['access', 'required_workflows'], - ['loop'], - ['ref', $date_RepoRequiredWorkflow], - ], - ], - }, - }, - }); -} -/** - * Get a required workflow entity for a repository - * Gets a specific required workflow present in a repository. Anyone with read access to the repository can use this - * endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the - * `actions:read` permission to use this endpoint. For more information, see "[Required - * Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-repository-required-workflow} - * Tags: actions - */ -export async function actionsGetRepoRequiredWorkflow( - ctx: r.Context, - params: { - org: string; - repo: string; - required_workflow_id_for_repo: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}', - params, - method: r.HttpMethod.GET, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { transforms: { date: [[['ref', $date_RepoRequiredWorkflow]]] } }, - }); -} -/** - * Get required workflow usage - * Gets the number of billable minutes used by a specific required workflow during the current billing cycle. - * - * Billable - * minutes only apply to required workflows running in private repositories that use GitHub-hosted runners. Usage is listed - * for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The - * usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. - * For more information, see "[Managing billing for GitHub - * Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)." - * - * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-repository-required-workflow-usage} - * Tags: actions - */ -export async function actionsGetRepoRequiredWorkflowUsage( - ctx: r.Context, - params: { - org: string; - repo: string; - required_workflow_id_for_repo: number; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing', - params, - method: r.HttpMethod.GET, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} /** * Get a repository * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository @@ -83878,7 +87958,7 @@ export async function actionsGetRepoRequiredWorkflowUsage( * block for a repository you must have admin permissions for the repository or be an owner or security manager for the * organization that owns the repository. For more information, see "[Managing security managers in your * organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/repos#get-a-repository} * Tags: repos */ export async function reposGet( @@ -83902,7 +87982,7 @@ export async function reposGet( /** * Update a repository * **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. + * topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. * Learn more at {@link https://docs.github.com/rest/repos/repos#update-a-repository} * Tags: repos */ @@ -84092,7 +88172,7 @@ export async function reposUpdate( * owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a * `403 Forbidden` response. - * Learn more at {@link https://docs.github.com/rest/reference/repos#delete-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/repos#delete-a-repository} * Tags: repos */ export async function reposDelete( @@ -84116,7 +88196,7 @@ export async function reposDelete( * Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository * is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository} * Tags: actions */ export async function actionsListArtifactsForRepo( @@ -84153,7 +88233,7 @@ export async function actionsListArtifactsForRepo( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-an-artifact} + * Learn more at {@link https://docs.github.com/rest/actions/artifacts#get-an-artifact} * Tags: actions */ export async function actionsGetArtifact( @@ -84179,7 +88259,7 @@ export async function actionsGetArtifact( * Delete an artifact * Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-an-artifact} + * Learn more at {@link https://docs.github.com/rest/actions/artifacts#delete-an-artifact} * Tags: actions */ export async function actionsDeleteArtifact( @@ -84203,12 +88283,13 @@ export async function actionsDeleteArtifact( * Download an artifact * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` * in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access - * to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` - * scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#download-an-artifact} + * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * + * You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:read` permission to + * use this endpoint. + * Learn more at {@link https://docs.github.com/rest/actions/artifacts#download-an-artifact} * Tags: actions */ export async function actionsDownloadArtifact( @@ -84237,7 +88318,7 @@ export async function actionsDownloadArtifact( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository} * Tags: actions */ export async function actionsGetActionsCacheUsage( @@ -84357,7 +88438,7 @@ export async function actionsDeleteActionsCacheById( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run} * Tags: actions */ export async function actionsGetJobForWorkflowRun( @@ -84388,7 +88469,7 @@ export async function actionsGetJobForWorkflowRun( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run} * Tags: actions */ export async function actionsDownloadJobLogsForWorkflowRun( @@ -84410,9 +88491,12 @@ export async function actionsDownloadJobLogsForWorkflowRun( } /** * Re-run a job from a workflow run - * Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope - * to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run} + * Re-run a job and its dependent jobs in a workflow run. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run} * Tags: actions */ export async function actionsReRunJobForWorkflowRun( @@ -84504,9 +88588,15 @@ export async function actionsSetCustomOidcSubClaimForRepo( } /** * List repository organization secrets - * Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate - * using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository + * Lists all organization secrets shared with a repository without revealing their encrypted + * values. + * + * You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read secrets. * Learn more at {@link https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets} * Tags: actions */ @@ -84540,9 +88630,13 @@ export async function actionsListRepoOrganizationSecrets( } /** * List repository organization variables - * Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this + * Lists all organiation variables shared with a repository. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + * GitHub Apps must have the `actions_variables:read` repository permission to use this * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#list-repository-organization-variables} * Tags: actions */ @@ -84583,7 +88677,7 @@ export async function actionsListRepoOrganizationVariables( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository} * Tags: actions */ export async function actionsGetGithubActionsPermissionsRepository( @@ -84609,7 +88703,7 @@ export async function actionsGetGithubActionsPermissionsRepository( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository} * Tags: actions */ export async function actionsSetGithubActionsPermissionsRepository( @@ -84646,7 +88740,7 @@ export async function actionsSetGithubActionsPermissionsRepository( * must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the * repository * `administration` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository} * Tags: actions */ export async function actionsGetWorkflowAccessToRepository( @@ -84678,7 +88772,7 @@ export async function actionsGetWorkflowAccessToRepository( * must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the * repository * `administration` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository} * Tags: actions */ export async function actionsSetWorkflowAccessToRepository( @@ -84708,7 +88802,7 @@ export async function actionsSetWorkflowAccessToRepository( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository} * Tags: actions */ export async function actionsGetAllowedActionsRepository( @@ -84736,7 +88830,7 @@ export async function actionsGetAllowedActionsRepository( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository} * Tags: actions */ export async function actionsSetAllowedActionsRepository( @@ -84769,7 +88863,7 @@ export async function actionsSetAllowedActionsRepository( * You * must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository * `administration` permission to use this API. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository} * Tags: actions */ export async function actionsGetGithubActionsDefaultWorkflowPermissionsRepository< @@ -84802,7 +88896,7 @@ export async function actionsGetGithubActionsDefaultWorkflowPermissionsRepositor * You * must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository * `administration` permission to use this API. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository} * Tags: actions */ export async function actionsSetGithubActionsDefaultWorkflowPermissionsRepository< @@ -84825,92 +88919,23 @@ export async function actionsSetGithubActionsDefaultWorkflowPermissionsRepositor const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } -/** - * List workflow runs for a required workflow - * List all workflow runs for a required workflow. You can use parameters to narrow the list of results. For more - * information about using parameters, see - * [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). - * - * Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-required-workflow-runs} - * Tags: actions - */ -export async function actionsListRequiredWorkflowRuns( - ctx: r.Context, - params: { - owner: string; - repo: string; - required_workflow_id_for_repo: number; - actor?: string; - branch?: string; - event?: string; - status?: - | 'completed' - | 'action_required' - | 'cancelled' - | 'failure' - | 'neutral' - | 'skipped' - | 'stale' - | 'success' - | 'timed_out' - | 'in_progress' - | 'queued' - | 'requested' - | 'waiting' - | 'pending'; - per_page?: number; - page?: number; - created?: Date; - exclude_pull_requests?: boolean; - check_suite_id?: number; - head_sha?: string; - }, - opts?: FetcherData, -): Promise<{ - total_count: number; - workflow_runs: WorkflowRun[]; -}> { - const req = await ctx.createRequest({ - path: '/repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs', - params, - method: r.HttpMethod.GET, - queryParams: [ - 'actor', - 'branch', - 'event', - 'status', - 'per_page', - 'page', - 'created', - 'exclude_pull_requests', - 'check_suite_id', - 'head_sha', - ], - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, { - '200': { - transforms: { - date: [ - [['access', 'workflow_runs'], ['loop'], ['ref', $date_WorkflowRun]], - ], - }, - }, - }); -} /** * List self-hosted runners for a repository - * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` + * Lists all self-hosted runners configured in a repository. + * + * You must authenticate using an access token with the `repo` * scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository} + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository} * Tags: actions */ export async function actionsListSelfHostedRunnersForRepo( ctx: r.Context, params: { + name?: string; owner: string; repo: string; per_page?: number; @@ -84925,7 +88950,7 @@ export async function actionsListSelfHostedRunnersForRepo( path: '/repos/{owner}/{repo}/actions/runners', params, method: r.HttpMethod.GET, - queryParams: ['per_page', 'page'], + queryParams: ['name', 'per_page', 'page'], }); const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); @@ -84936,7 +88961,11 @@ export async function actionsListSelfHostedRunnersForRepo( * * You must authenticate using an access token * with the `repo` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository} + * GitHub Apps must have the `administration` permission for repositories and + * the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository} * Tags: actions */ export async function actionsListRunnerApplicationsForRepo( @@ -84961,6 +88990,11 @@ export async function actionsListRunnerApplicationsForRepo( * * You must authenticate using an * access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for + * repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have + * admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these + * endpoints. * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository} * Tags: actions */ @@ -85008,20 +89042,26 @@ export async function actionsGenerateRunnerJitconfigForRepo( } /** * Create a registration token for a repository - * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate - * using + * Returns a token that you can pass to the `config` script. The token + * expires after one hour. + * + * You must authenticate using * an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for + * repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have + * admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these + * endpoints. * - * #### Example using registration token + * Example using registration token: * - * Configure your - * self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the + * registration token provided + * by this endpoint. * - * ``` - * ./config.sh --url - * https://github.com/octo-org/octo-repo-artifacts --token TOKEN - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository} + * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts + * --token TOKEN``` + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository} * Tags: actions */ export async function actionsCreateRegistrationTokenForRepo( @@ -85044,20 +89084,26 @@ export async function actionsCreateRegistrationTokenForRepo( } /** * Create a remove token for a repository - * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one + * Returns a token that you can pass to remove a self-hosted runner from + * a repository. The token expires after one * hour. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the + * `administration` permission for repositories and the `organization_self_hosted_runners` permission for + * organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * #### Example using remove - * token + * Example using remove token: * - * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this - * endpoint. + * To remove your + * self-hosted runner from a repository, replace TOKEN with + * the remove token provided by this endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository} + * ```config.sh + * remove --token TOKEN``` + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository} * Tags: actions */ export async function actionsCreateRemoveTokenForRepo( @@ -85083,9 +89129,12 @@ export async function actionsCreateRemoveTokenForRepo( * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the - * `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository} + * `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsGetSelfHostedRunnerForRepo( @@ -85110,10 +89159,13 @@ export async function actionsGetSelfHostedRunnerForRepo( * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner * when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` - * scope to + * You must authenticate using an access token with the `repo` scope to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository} + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository} * Tags: actions */ export async function actionsDeleteSelfHostedRunnerFromRepo( @@ -85138,9 +89190,12 @@ export async function actionsDeleteSelfHostedRunnerFromRepo( * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with - * the `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository} + * the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsListLabelsForSelfHostedRunnerForRepo( @@ -85168,9 +89223,12 @@ export async function actionsListLabelsForSelfHostedRunnerForRepo( * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with - * the `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository} + * the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the + * `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to + * repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsAddCustomLabelsToSelfHostedRunnerForRepo< @@ -85208,9 +89266,13 @@ export async function actionsAddCustomLabelsToSelfHostedRunnerForRepo< * self-hosted runner configured in a * repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository} + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must + * have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for + * organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsSetCustomLabelsForSelfHostedRunnerForRepo< @@ -85248,9 +89310,13 @@ export async function actionsSetCustomLabelsForSelfHostedRunnerForRepo< * repository. Returns the remaining read-only labels * from the runner. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository} + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps + * must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for + * organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepo< @@ -85285,9 +89351,13 @@ export async function actionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepo< * present on the runner. * * You must - * authenticate using an access token with the `repo` scope to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository} + * authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the + * `administration` permission for repositories and the `organization_self_hosted_runners` permission for + * organizations. + * Authenticated users must have admin access to repositories or organizations, or the + * `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Learn more at {@link https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository} * Tags: actions */ export async function actionsRemoveCustomLabelFromSelfHostedRunnerForRepo< @@ -85322,7 +89392,7 @@ export async function actionsRemoveCustomLabelFromSelfHostedRunnerForRepo< * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository} * Tags: actions */ export async function actionsListWorkflowRunsForRepo( @@ -85393,7 +89463,7 @@ export async function actionsListWorkflowRunsForRepo( * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use * this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run} * Tags: actions */ export async function actionsGetWorkflowRun( @@ -85424,7 +89494,7 @@ export async function actionsGetWorkflowRun( * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to * use * this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run} * Tags: actions */ export async function actionsDeleteWorkflowRun( @@ -85448,7 +89518,7 @@ export async function actionsDeleteWorkflowRun( * Get the review history 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run} * Tags: actions */ export async function actionsGetReviewsForRun( @@ -85481,7 +89551,7 @@ export async function actionsGetReviewsForRun( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request} * Tags: actions */ export async function actionsApproveWorkflowRun( @@ -85506,7 +89576,7 @@ export async function actionsApproveWorkflowRun( * Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository * is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts} + * Learn more at {@link https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts} * Tags: actions */ export async function actionsListWorkflowRunArtifacts( @@ -85517,6 +89587,7 @@ export async function actionsListWorkflowRunArtifacts( run_id: number; per_page?: number; page?: number; + name?: string; }, opts?: FetcherData, ): Promise<{ @@ -85527,7 +89598,7 @@ export async function actionsListWorkflowRunArtifacts( path: '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts', params, method: r.HttpMethod.GET, - queryParams: ['per_page', 'page'], + queryParams: ['per_page', 'page', 'name'], }); const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, { @@ -85546,7 +89617,7 @@ export async function actionsListWorkflowRunArtifacts( * with the `repo` scope. GitHub Apps must have the `actions:read` permission * to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt} * Tags: actions */ export async function actionsGetWorkflowRunAttempt( @@ -85577,7 +89648,7 @@ export async function actionsGetWorkflowRunAttempt( * 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). - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt} * Tags: actions */ export async function actionsListJobsForWorkflowRunAttempt( @@ -85619,7 +89690,7 @@ export async function actionsListJobsForWorkflowRunAttempt( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs} * Tags: actions */ export async function actionsDownloadWorkflowRunAttemptLogs( @@ -85642,9 +89713,12 @@ export async function actionsDownloadWorkflowRunAttemptLogs( } /** * Cancel a workflow run - * Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#cancel-a-workflow-run} + * Cancels a workflow run using its `id`. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run} * Tags: actions */ export async function actionsCancelWorkflowRun( @@ -85676,8 +89750,10 @@ export async function actionsCancelWorkflowRun( * are waiting for review from a specific person or team, see [`POST * /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * GitHub - * Apps must have read and write permission for **Deployments** to use this endpoint. + * If + * the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have read and write + * permission for **Deployments** to use this endpoint. * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run} * Tags: actions */ @@ -85700,13 +89776,45 @@ export async function actionsReviewCustomGatesForRun( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * Force cancel a workflow run + * Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an + * `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not + * responding to [`POST + * /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must + * authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` + * permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run} + * Tags: actions + */ +export async function actionsForceCancelWorkflowRun( + ctx: r.Context, + params: { + owner: string; + repo: string; + run_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel', + params, + method: r.HttpMethod.POST, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List jobs for a workflow run * 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). - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run} * Tags: actions */ export async function actionsListJobsForWorkflowRun( @@ -85748,7 +89856,7 @@ export async function actionsListJobsForWorkflowRun( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#download-workflow-run-logs} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs} * Tags: actions */ export async function actionsDownloadWorkflowRunLogs( @@ -85772,7 +89880,7 @@ export async function actionsDownloadWorkflowRunLogs( * Delete workflow run logs * Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-workflow-run-logs} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs} * Tags: actions */ export async function actionsDeleteWorkflowRunLogs( @@ -85799,7 +89907,7 @@ export async function actionsDeleteWorkflowRunLogs( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run} * Tags: actions */ export async function actionsGetPendingDeploymentsForRun( @@ -85830,7 +89938,7 @@ export async function actionsGetPendingDeploymentsForRun( * Required reviewers with read * access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an * access token with the `repo` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run} * Tags: actions */ export async function actionsReviewPendingDeploymentsForRun( @@ -85878,7 +89986,7 @@ export async function actionsReviewPendingDeploymentsForRun( * Re-run a workflow * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#re-run-a-workflow} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow} * Tags: actions */ export async function actionsReRunWorkflow( @@ -85909,7 +90017,7 @@ export async function actionsReRunWorkflow( * Re-run failed jobs from a workflow run * Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must * authenticate using an access token with the `repo` scope to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run} * Tags: actions */ export async function actionsReRunWorkflowFailedJobs( @@ -85948,7 +90056,7 @@ export async function actionsReRunWorkflowFailedJobs( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-workflow-run-usage} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage} * Tags: actions */ export async function actionsGetWorkflowRunUsage( @@ -85970,10 +90078,15 @@ export async function actionsGetWorkflowRunUsage( } /** * List repository secrets - * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an - * access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to + * Lists all secrets available in a repository without revealing their encrypted + * values. + * + * You must authenticate using an + * access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-repository-secrets} + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#list-repository-secrets} * Tags: actions */ export async function actionsListRepoSecrets( @@ -86006,10 +90119,17 @@ export async function actionsListRepoSecrets( } /** * Get a repository public key - * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update - * secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an - * access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-repository-public-key} + * Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update + * secrets. + * + * Anyone with read access to the repository can use this endpoint. + * If the repository is private you must use an + * access token with the `repo` scope. + * GitHub Apps must have the `secrets` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-a-repository-public-key} * Tags: actions */ export async function actionsGetRepoPublicKey( @@ -86030,9 +90150,14 @@ export async function actionsGetRepoPublicKey( } /** * Get a repository secret - * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with - * the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-repository-secret} + * Gets a single repository secret without revealing its encrypted value. + * + * You must authenticate using an access token with + * the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-a-repository-secret} * Tags: actions */ export async function actionsGetRepoSecret( @@ -86058,104 +90183,16 @@ export async function actionsGetRepoSecret( * Create or update a repository secret * Creates or updates a repository secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to - * use - * this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the - * [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret} + * You must + * authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` + * repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, + * update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret} * Tags: actions */ export async function actionsCreateOrUpdateRepoSecret( @@ -86167,7 +90204,7 @@ export async function actionsCreateOrUpdateRepoSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @@ -86188,9 +90225,14 @@ export async function actionsCreateOrUpdateRepoSecret( } /** * Delete a repository secret - * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-a-repository-secret} + * Deletes a secret in a repository using the secret name. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#delete-a-repository-secret} * Tags: actions */ export async function actionsDeleteRepoSecret( @@ -86212,8 +90254,12 @@ export async function actionsDeleteRepoSecret( } /** * List repository variables - * Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. + * Lists all repository variables. + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Authenticated + * users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#list-repository-variables} * Tags: actions */ @@ -86250,10 +90296,13 @@ export async function actionsListRepoVariables( /** * Create a repository variable * Creates a repository variable that you can reference in a GitHub Actions workflow. - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. + * + * You must authenticate using an + * access token with the `repo` scope to use this endpoint. * GitHub Apps must have the `actions_variables:write` repository * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#create-a-repository-variable} * Tags: actions */ @@ -86286,8 +90335,13 @@ export async function actionsCreateRepoVariable( } /** * Get a repository variable - * Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Gets a specific variable in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Authenticated + * users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#get-a-repository-variable} * Tags: actions */ @@ -86313,10 +90367,13 @@ export async function actionsGetRepoVariable( /** * Update a repository variable * Updates a repository variable that you can reference in a GitHub Actions workflow. - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. + * + * You must authenticate using an + * access token with the `repo` scope to use this endpoint. * GitHub Apps must have the `actions_variables:write` repository * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#update-a-repository-variable} * Tags: actions */ @@ -86351,9 +90408,12 @@ export async function actionsUpdateRepoVariable( /** * Delete a repository variable * Deletes a repository variable using the variable name. - * You must authenticate using an access token with the `repo` scope - * to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + * GitHub Apps must have the `actions_variables:write` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#delete-a-repository-variable} * Tags: actions */ @@ -86379,7 +90439,7 @@ export async function actionsDeleteRepoVariable( * Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository * is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-repository-workflows} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#list-repository-workflows} * Tags: actions */ export async function actionsListRepoWorkflows( @@ -86415,7 +90475,7 @@ export async function actionsListRepoWorkflows( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-a-workflow} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#get-a-workflow} * Tags: actions */ export async function actionsGetWorkflow( @@ -86444,7 +90504,7 @@ export async function actionsGetWorkflow( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#disable-a-workflow} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#disable-a-workflow} * Tags: actions */ export async function actionsDisableWorkflow( @@ -86479,7 +90539,7 @@ export async function actionsDisableWorkflow( * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event} * Tags: actions */ export async function actionsCreateWorkflowDispatch( @@ -86519,7 +90579,7 @@ export async function actionsCreateWorkflowDispatch( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#enable-a-workflow} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#enable-a-workflow} * Tags: actions */ export async function actionsEnableWorkflow( @@ -86547,7 +90607,7 @@ export async function actionsEnableWorkflow( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-workflow-runs} + * Learn more at {@link https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow} * Tags: actions */ export async function actionsListWorkflowRuns( @@ -86627,7 +90687,7 @@ export async function actionsListWorkflowRuns( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-workflow-usage} + * Learn more at {@link https://docs.github.com/rest/actions/workflows#get-workflow-usage} * Tags: actions */ export async function actionsGetWorkflowUsage( @@ -86647,12 +90707,66 @@ export async function actionsGetWorkflowUsage( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * List repository activities + * Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and + * associates these changes with commits and users. + * + * For more information about viewing repository activity, + * see "[Viewing + * activity and data for your + * repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repository-activities} + * Tags: repos + */ +export async function reposListActivities( + ctx: r.Context, + params: { + owner: string; + repo: string; + direction?: 'asc' | 'desc'; + per_page?: number; + before?: string; + after?: string; + ref?: string; + actor?: string; + time_period?: 'day' | 'week' | 'month' | 'quarter' | 'year'; + activity_type?: + | 'push' + | 'force_push' + | 'branch_creation' + | 'branch_deletion' + | 'pr_merge' + | 'merge_queue_merge'; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/activity', + params, + method: r.HttpMethod.GET, + queryParams: [ + 'direction', + 'per_page', + 'before', + 'after', + 'ref', + 'actor', + 'time_period', + 'activity_type', + ], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['loop'], ['ref', $date_Activity]]] } }, + }); +} /** * List assignees * Lists the [available * assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a * repository. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-assignees} + * Learn more at {@link https://docs.github.com/rest/issues/assignees#list-assignees} * Tags: issues */ export async function issuesListAssignees( @@ -86682,7 +90796,7 @@ export async function issuesListAssignees( * issues in the repository, a `204` header with no content is returned. * * Otherwise a `404` status code is returned. - * Learn more at {@link https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned} + * Learn more at {@link https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned} * Tags: issues */ export async function issuesCheckUserCanBeAssigned( @@ -86819,12 +90933,36 @@ export async function reposDeleteAutolink( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * Check if automated security fixes are enabled for a repository + * Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must + * have admin read access to the repository. For more information, see "[Configuring automated security + * fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Learn more at {@link https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository} + * Tags: repos + */ +export async function reposCheckAutomatedSecurityFixes( + ctx: r.Context, + params: { + owner: string; + repo: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/automated-security-fixes', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * Enable automated security fixes * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For * more information, see "[Configuring automated security * fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". - * Learn more at {@link https://docs.github.com/rest/reference/repos#enable-automated-security-fixes} + * Learn more at {@link https://docs.github.com/rest/repos/repos#enable-automated-security-fixes} * Tags: repos */ export async function reposEnableAutomatedSecurityFixes( @@ -86848,7 +90986,7 @@ export async function reposEnableAutomatedSecurityFixes( * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For * more information, see "[Configuring automated security * fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". - * Learn more at {@link https://docs.github.com/rest/reference/repos#disable-automated-security-fixes} + * Learn more at {@link https://docs.github.com/rest/repos/repos#disable-automated-security-fixes} * Tags: repos */ export async function reposDisableAutomatedSecurityFixes( @@ -87765,7 +91903,7 @@ export async function reposDeleteAccessRestrictions( * * 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. - * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch} + * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch} * Tags: repos */ export async function reposGetAppsWithAccessToProtectedBranch( @@ -87916,7 +92054,7 @@ export async function reposRemoveAppAccessRestrictions( * in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. - * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch} + * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch} * Tags: repos */ export async function reposGetTeamsWithAccessToProtectedBranch( @@ -88059,7 +92197,7 @@ export async function reposRemoveTeamAccessRestrictions( * in the GitHub Help documentation. * * Lists the people who have push access to this branch. - * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch} + * Learn more at {@link https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch} * Tags: repos */ export async function reposGetUsersWithAccessToProtectedBranch( @@ -88278,7 +92416,7 @@ export async function reposRenameBranch( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/checks#create-a-check-run} + * Learn more at {@link https://docs.github.com/rest/checks/runs#create-a-check-run} * Tags: checks */ export async function checksCreate( @@ -88308,9 +92446,9 @@ export async function checksCreate( * * Gets a single check run * using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public - * repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a + * repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a * private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#get-a-check-run} + * Learn more at {@link https://docs.github.com/rest/checks/runs#get-a-check-run} * Tags: checks */ export async function checksGet( @@ -88334,12 +92472,13 @@ export async function checksGet( } /** * Update a check run - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes - * to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to + * edit check runs. * - * Updates a check run for - * a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. - * Learn more at {@link https://docs.github.com/rest/reference/checks#update-a-check-run} + * **Note:** The endpoints to manage checks only look 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. + * Learn more at {@link https://docs.github.com/rest/checks/runs#update-a-check-run} * Tags: checks */ export async function checksUpdate( @@ -88366,9 +92505,9 @@ export async function checksUpdate( /** * List check run annotations * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a - * private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and + * private repository or pull access to a public repository to get annotations for a check run. OAuth apps and * authenticated users must have the `repo` scope to get annotations for a check run in a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#list-check-run-annotations} + * Learn more at {@link https://docs.github.com/rest/checks/runs#list-check-run-annotations} * Tags: checks */ export async function checksListAnnotations( @@ -88403,7 +92542,7 @@ export async function checksListAnnotations( * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow * run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * Learn more at {@link https://docs.github.com/rest/reference/checks#rerequest-a-check-run} + * Learn more at {@link https://docs.github.com/rest/checks/runs#rerequest-a-check-run} * Tags: checks */ export async function checksRerequestRun( @@ -88430,11 +92569,11 @@ export async function checksRerequestRun( * `head_branch`. * * By default, check suites are automatically created when you create a [check - * run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating - * check suites when you've disabled automatic creation using "[Update repository preferences for check - * suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App + * run](https://docs.github.com/rest/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://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App * must have the `checks:write` permission to create check suites. - * Learn more at {@link https://docs.github.com/rest/reference/checks#create-a-check-suite} + * Learn more at {@link https://docs.github.com/rest/checks/suites#create-a-check-suite} * Tags: checks */ export async function checksCreateSuite( @@ -88467,9 +92606,9 @@ export async function checksCreateSuite( * Update repository 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 + * check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the * repository to set preferences for check suites. - * Learn more at {@link https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites} + * Learn more at {@link https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites} * Tags: checks */ export async function checksSetSuitesPreferences( @@ -88514,9 +92653,9 @@ export async function checksSetSuitesPreferences( * `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a - * private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must + * private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must * have the `repo` scope to get check suites in a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#get-a-check-suite} + * Learn more at {@link https://docs.github.com/rest/checks/suites#get-a-check-suite} * Tags: checks */ export async function checksGetSuite( @@ -88540,14 +92679,14 @@ export async function checksGetSuite( } /** * List check runs in a check suite - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes - * to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Lists check runs for a - * check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to - * a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs - * in a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite} + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private + * repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the + * `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look 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. + * Learn more at {@link https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite} * Tags: checks */ export async function checksListForSuite( @@ -88589,9 +92728,9 @@ export async function checksListForSuite( * `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 + * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or * pull access to a public repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#rerequest-a-check-suite} + * Learn more at {@link https://docs.github.com/rest/checks/suites#rerequest-a-check-suite} * Tags: checks */ export async function checksRerequestSuite( @@ -88627,7 +92766,7 @@ export async function checksRerequestSuite( * provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if * you used `ref` in the request). - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository} * Tags: code-scanning */ export async function codeScanningListAlertsForRepo( @@ -88642,7 +92781,7 @@ export async function codeScanningListAlertsForRepo( ref?: CodeScanningRef; direction?: 'asc' | 'desc'; sort?: 'created' | 'updated'; - state?: CodeScanningAlertState; + state?: CodeScanningAlertStateQuery; severity?: CodeScanningAlertSeverity; }, opts?: FetcherData, @@ -88675,7 +92814,7 @@ export async function codeScanningListAlertsForRepo( * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint * with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub * Apps must have the `security_events` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert} * Tags: code-scanning */ export async function codeScanningGetAlert( @@ -88702,7 +92841,7 @@ export async function codeScanningGetAlert( * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use * this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories * only. GitHub Apps must have the `security_events` write permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert} * Tags: code-scanning */ export async function codeScanningUpdateAlert( @@ -88738,7 +92877,7 @@ export async function codeScanningUpdateAlert( * the `public_repo` scope also grants permission to read security events on * public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert} * Tags: code-scanning */ export async function codeScanningListAlertInstances( @@ -88789,7 +92928,7 @@ export async function codeScanningListAlertInstances( * The `tool_name` field is deprecated and will, in future, not be included in * the response for this endpoint. The example response reflects this change. The tool name can now be found inside the * `tool` field. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository} * Tags: code-scanning */ export async function codeScanningListRecentAnalyses( @@ -88859,7 +92998,7 @@ export async function codeScanningListRecentAnalyses( * This is formatted as * [SARIF version * 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository} * Tags: code-scanning */ export async function codeScanningGetAnalysis( @@ -88975,7 +93114,7 @@ export async function codeScanningGetAnalysis( * interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could * use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's * analysis entirely. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository} * Tags: code-scanning */ export async function codeScanningDeleteAnalysis( @@ -89006,7 +93145,7 @@ export async function codeScanningDeleteAnalysis( * For public repositories, you can use tokens with the `security_events` or * `public_repo` scope. * GitHub Apps must have the `contents` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#list-codeql-databases-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository} * Tags: code-scanning */ export async function codeScanningListCodeqlDatabases( @@ -89050,7 +93189,7 @@ export async function codeScanningListCodeqlDatabases( * with the `security_events` or `public_repo` scope. * GitHub Apps must have the `contents` read permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#get-a-codeql-database-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository} * Tags: code-scanning */ export async function codeScanningGetCodeqlDatabase( @@ -89081,7 +93220,7 @@ export async function codeScanningGetCodeqlDatabase( * endpoint with private repos or the `public_repo` * scope for public repos. GitHub Apps must have the `repo` write * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/code-scanning#get-a-code-scanning-default-setup-configuration} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration} * Tags: code-scanning */ export async function codeScanningGetDefaultSetup( @@ -89111,7 +93250,7 @@ export async function codeScanningGetDefaultSetup( * endpoint with private repos or the `public_repo` * scope for public repos. GitHub Apps must have the `repo` write * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/code-scanning#update-a-code-scanning-default-setup-configuration} + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration} * Tags: code-scanning */ export async function codeScanningUpdateDefaultSetup( @@ -89137,16 +93276,17 @@ export async function codeScanningUpdateDefaultSetup( * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You * must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also * use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write - * permission to use this endpoint. - * - * There are two places where you can upload code scanning results. - * - If you upload to a - * pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in - * a pull request check. For more information, see "[Triaging code scanning alerts in pull - * requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - If you upload to a branch, - * for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more - * information, see "[Managing code scanning alerts for your + * permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF + * uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * + * There are two places where you + * can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref + * refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code + * scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - If + * you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for + * your repository. For more information, see "[Managing code scanning alerts for your * repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." * * You @@ -89163,10 +93303,12 @@ export async function codeScanningUpdateDefaultSetup( * most important entries whenever applicable. * To get the most out of your analysis when it includes data above the * supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the - * most noisy queries. + * most noisy queries. For more information, see "[SARIF results exceed one or more + * limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** + * | **SARIF + * data** | **Maximum values** | **Additional limits** * * | * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| @@ -89192,8 +93334,8 @@ export async function codeScanningUpdateDefaultSetup( * You can use this ID to check the status of the * upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF - * upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#upload-an-analysis-as-sarif-data} + * upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data} * Tags: code-scanning */ export async function codeScanningUploadSarif( @@ -89241,11 +93383,11 @@ export async function codeScanningUploadSarif( * Get information about a SARIF upload * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you * can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a - * repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token - * with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission - * to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/code-scanning#get-information-about-a-sarif-upload} + * repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access + * token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants + * permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to + * use this endpoint. + * Learn more at {@link https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload} * Tags: code-scanning */ export async function codeScanningGetSarif( @@ -89274,7 +93416,7 @@ export async function codeScanningGetSarif( * syntax, * see "[About code * owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-codeowners-errors} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-codeowners-errors} * Tags: repos */ export async function reposCodeownersErrors( @@ -89304,7 +93446,7 @@ export async function reposCodeownersErrors( * * GitHub Apps must have read access to the `codespaces` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesListInRepositoryForAuthenticatedUser< @@ -89346,7 +93488,7 @@ export async function codespacesListInRepositoryForAuthenticatedUser< * * GitHub Apps must have write access to the `codespaces` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository} * Tags: codespaces */ export async function codespacesCreateWithRepoForAuthenticatedUser( @@ -89426,7 +93568,7 @@ export async function codespacesCreateWithRepoForAuthenticatedUser( * * GitHub Apps must have read access to the `codespaces_metadata` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesListDevcontainersInRepositoryForAuthenticatedUser< @@ -89466,7 +93608,7 @@ export async function codespacesListDevcontainersInRepositoryForAuthenticatedUse * * GitHub Apps must have write access to the * `codespaces_metadata` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository} * Tags: codespaces */ export async function codespacesRepoMachinesForAuthenticatedUser( @@ -89476,6 +93618,7 @@ export async function codespacesRepoMachinesForAuthenticatedUser( repo: string; location?: string; client_ip?: string; + ref?: string; }, opts?: FetcherData, ): Promise< @@ -89489,7 +93632,7 @@ export async function codespacesRepoMachinesForAuthenticatedUser( path: '/repos/{owner}/{repo}/codespaces/machines', params, method: r.HttpMethod.GET, - queryParams: ['location', 'client_ip'], + queryParams: ['location', 'client_ip', 'ref'], }); const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); @@ -89503,7 +93646,7 @@ export async function codespacesRepoMachinesForAuthenticatedUser( * * GitHub Apps must have write access to the `codespaces` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace} * Tags: codespaces */ export async function codespacesPreFlightWithRepoForAuthenticatedUser< @@ -89533,12 +93676,43 @@ export async function codespacesPreFlightWithRepoForAuthenticatedUser< const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * Check if permissions defined by a devcontainer have been accepted by the authenticated user + * Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated + * user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must + * have write access to the `codespaces` repository permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user} + * Tags: codespaces + */ +export async function codespacesCheckPermissionsForDevcontainer( + ctx: r.Context, + params: { + owner: string; + repo: string; + ref: string; + devcontainer_path: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/codespaces/permissions_check', + params, + method: r.HttpMethod.GET, + queryParams: ['ref', 'devcontainer_path'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List repository secrets * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an * access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-repository-secrets} + * Learn more at {@link https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets} * Tags: codespaces */ export async function codespacesListRepoSecrets( @@ -89581,7 +93755,7 @@ export async function codespacesListRepoSecrets( * secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an * access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission * to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key} + * Learn more at {@link https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key} * Tags: codespaces */ export async function codespacesGetRepoPublicKey( @@ -89605,7 +93779,7 @@ export async function codespacesGetRepoPublicKey( * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with * the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-a-repository-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret} * Tags: codespaces */ export async function codespacesGetRepoSecret( @@ -89631,106 +93805,15 @@ export async function codespacesGetRepoSecret( * Create or update a repository secret * Creates or updates a repository secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * You must + * authenticate using an access * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the * `codespaces_secrets` * repository permission to use this endpoint. - * - * #### Example of encrypting a secret using - * Node.js - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) - * library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret - * you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if - * libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let - * binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt - * the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * #### - * Example of encrypting a secret using Python - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example of - * encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example of encrypting a secret - * using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-or-update-a-repository-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret} * Tags: codespaces */ export async function codespacesCreateOrUpdateRepoSecret( @@ -89742,7 +93825,7 @@ export async function codespacesCreateOrUpdateRepoSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @@ -89766,7 +93849,7 @@ export async function codespacesCreateOrUpdateRepoSecret( * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` * scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use * this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret} * Tags: codespaces */ export async function codespacesDeleteRepoSecret( @@ -89891,8 +93974,8 @@ export async function reposCheckCollaborator( * * 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). + * notifications page, the email they receive, or by using the + * [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission * level** @@ -90025,11 +94108,11 @@ export async function reposGetCollaboratorPermissionLevel( } /** * List commit comments for a repository - * 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/). + * Commit Comments use [these custom media types](https://docs.github.com/rest/overview/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. + * Comments are + * ordered by ascending ID. * Learn more at {@link https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository} * Tags: repos */ @@ -90133,8 +94216,8 @@ export async function reposDeleteCommitComment( } /** * List reactions for a commit comment - * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment} + * List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment} * Tags: reactions */ export async function reactionsListForCommitComment( @@ -90170,9 +94253,9 @@ export async function reactionsListForCommitComment( } /** * Create reaction for a commit comment - * Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP - * `200` status means that you already added the reaction type to this commit comment. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-a-commit-comment} + * Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response + * with an HTTP `200` status means that you already added the reaction type to this commit comment. + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment} * Tags: reactions */ export async function reactionsCreateForCommitComment( @@ -90184,7 +94267,7 @@ export async function reactionsCreateForCommitComment( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. */ content: | '+1' @@ -90216,8 +94299,8 @@ export async function reactionsCreateForCommitComment( * /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit - * comment](https://docs.github.com/rest/reference/repos#comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-a-commit-comment-reaction} + * comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction} * Tags: reactions */ export async function reactionsDeleteForCommitComment( @@ -90435,6 +94518,9 @@ export async function reposCreateCommitComment( * List pull requests associated with a commit * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default * branch, will only return open pull requests associated with the commit. + * + * To list the open or merged pull requests + * associated with a branch, you can set the `commit_sha` parameter to the branch name. * Learn more at {@link https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit} * Tags: repos */ @@ -90551,14 +94637,21 @@ export async function reposGetCommit( } /** * List check runs for a Git reference - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes - * to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Lists check runs for a - * commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a - * private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have - * the `repo` scope to get check runs in a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference} + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the + * `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and + * authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to + * manage checks only look 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. + * + * If there are more than 1000 check + * suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate + * over all possible check runs, use the [List check suites for a Git + * reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the + * `check_suite_id` parameter to the [List check runs in a check + * suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * Learn more at {@link https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference} * Tags: checks */ export async function checksListForRef( @@ -90603,14 +94696,15 @@ export async function checksListForRef( } /** * List check suites for a Git reference - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes - * to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for - * `head_branch`. + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the + * `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps + * and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps - * must have the `checks:read` permission on a private repository or pull access to a public repository to list check - * suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference} + * **Note:** The endpoints + * to manage checks only look 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`. + * Learn more at {@link https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference} * Tags: checks */ export async function checksListSuitesForRef( @@ -90726,15 +94820,13 @@ export async function reposListCommitStatusesForRef( * * The * `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, - * CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` - * is `100`. If only one is present, then the - * `health_percentage` is `25`. - * - * `content_reports_enabled` is only returned for - * organization-owned repositories. + * the recommended community health files are present. + * For more information, see + * "[About community profiles for public + * repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + * + * `content_reports_enabled` + * is only returned for organization-owned repositories. * Learn more at {@link https://docs.github.com/rest/metrics/community#get-community-profile-metrics} * Tags: repos */ @@ -90870,27 +94962,27 @@ export async function reposCompareCommits( * the API response includes for directories. * * Files and symlinks support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) for - * retrieving the raw content or rendered HTML - * (when supported). All content types support [a custom - * media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a - * consistent + * type](https://docs.github.com/rest/overview/media-types) for + * retrieving the raw content or rendered HTML (when + * supported). All content types support [a custom media + * type](https://docs.github.com/rest/overview/media-types) to ensure + * the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the - * tree](https://docs.github.com/rest/reference/git#trees). - * * This API has an upper limit of 1,000 files for a directory. - * If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/reference/git#get-a-tree). - * * - * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the - * contents API to obtain a fresh download URL for each download. - * #### Size limits + * * To get a repository's contents recursively, you + * can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * * This API has an upper limit of + * 1,000 files for a directory. If you need to retrieve more files, use the [Git + * Trees + * API](https://docs.github.com/rest/git/trees#get-a-tree). + * * Download URLs expire and are meant to be used just + * once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each + * download. + * Size limits: * If the requested file's size is: - * * 1 MB - * or smaller: All features of this endpoint are supported. + * * 1 MB or smaller: All features of this endpoint are + * supported. * * Between 1-100 MB: Only the `raw` or `object` [custom media * types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will * work as normal, except that when using the `object` media type, the `content` field will be an empty string and the @@ -90898,35 +94990,35 @@ export async function reposCompareCommits( * * Greater than * 100 MB: This endpoint is not supported. * - * #### If the content is a directory - * The response will be an array of objects, - * one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" - * specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards - * compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as - * "submodule". - * - * #### If the content is a symlink - * If the requested `:path` points to a symlink, and the symlink's target - * is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the - * example. Otherwise, the API responds with an object + * If the content is a directory: + * The response will be an array of objects, one + * object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified + * as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility + * purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * If + * the content is a symlink: + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in + * the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the + * API responds with an object * describing the symlink itself. * - * #### If the content is a - * submodule - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a - * specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and - * checks out - * the submodule at that specific commit. + * If the content is a submodule: + * The `submodule_git_url` + * identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule + * repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific + * commit. * - * If the submodule repository is not hosted on github.com, the Git URLs - * (`git_url` and `_links["git"]`) and the + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and + * the * github.com URLs (`html_url` and `_links["html"]`) will have null values. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-repository-content} + * Learn more at {@link https://docs.github.com/rest/repos/contents#get-repository-content} * Tags: repos */ export async function reposGetContent( @@ -90953,12 +95045,13 @@ export async function reposGetContent( /** * Create or update file contents * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the - * `workflow` scope to use this endpoint. + * `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must + * authenticate using an access token with the `workflow` scope. * * **Note:** If you use this endpoint and the "[Delete a - * file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will + * file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will * conflict and you will receive errors. You must use these endpoints serially instead. - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-or-update-file-contents} + * Learn more at {@link https://docs.github.com/rest/repos/contents#create-or-update-file-contents} * Tags: repos */ export async function reposCreateOrUpdateFileContents( @@ -91047,9 +95140,9 @@ export async function reposCreateOrUpdateFileContents( * code. * * **Note:** If you use this endpoint and the "[Create or update file - * contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the + * contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the * concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * Learn more at {@link https://docs.github.com/rest/reference/repos#delete-a-file} + * Learn more at {@link https://docs.github.com/rest/repos/contents#delete-a-file} * Tags: repos */ export async function reposDeleteFile( @@ -91120,7 +95213,7 @@ export async function reposDeleteFile( * counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author * email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without * associated GitHub user information. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repository-contributors} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repository-contributors} * Tags: repos */ export async function reposListContributors( @@ -91150,7 +95243,7 @@ export async function reposListContributors( * also use tokens with the `public_repo` scope for public repositories only. * GitHub Apps must have **Dependabot alerts** * read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository} * Tags: dependabot */ export async function dependabotListAlertsForRepo( @@ -91210,7 +95303,7 @@ export async function dependabotListAlertsForRepo( * also use tokens with the `public_repo` scope for public repositories only. * GitHub Apps must have **Dependabot alerts** * read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#get-a-dependabot-alert} + * Learn more at {@link https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert} * Tags: dependabot */ export async function dependabotGetAlert( @@ -91243,7 +95336,7 @@ export async function dependabotGetAlert( * To use this endpoint, you must have access to security alerts for the * repository. For more information, see "[Granting access to security * alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#update-a-dependabot-alert} + * Learn more at {@link https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert} * Tags: dependabot */ export async function dependabotUpdateAlert( @@ -91291,7 +95384,7 @@ export async function dependabotUpdateAlert( * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an * access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#list-repository-secrets} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#list-repository-secrets} * Tags: dependabot */ export async function dependabotListRepoSecrets( @@ -91330,7 +95423,7 @@ export async function dependabotListRepoSecrets( * secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an * access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key} * Tags: dependabot */ export async function dependabotGetRepoPublicKey( @@ -91354,7 +95447,7 @@ export async function dependabotGetRepoPublicKey( * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with * the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#get-a-repository-secret} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret} * Tags: dependabot */ export async function dependabotGetRepoSecret( @@ -91380,104 +95473,15 @@ export async function dependabotGetRepoSecret( * Create or update a repository secret * Creates or updates a repository secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - * repository - * permission to use this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using - * the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret} + * You must + * authenticate using an access + * token with the `repo` scope to use this endpoint. GitHub Apps must have the + * `dependabot_secrets` repository + * permission to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret} * Tags: dependabot */ export async function dependabotCreateOrUpdateRepoSecret( @@ -91489,7 +95493,7 @@ export async function dependabotCreateOrUpdateRepoSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @@ -91512,7 +95516,7 @@ export async function dependabotCreateOrUpdateRepoSecret( * Delete a repository secret * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` * scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret} + * Learn more at {@link https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret} * Tags: dependabot */ export async function dependabotDeleteRepoSecret( @@ -91536,7 +95540,7 @@ export async function dependabotDeleteRepoSecret( * Get a diff of the dependencies between commits * Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency * manifests made in those commits. - * Learn more at {@link https://docs.github.com/rest/reference/dependency-graph#get-a-diff-of-the-dependencies-between-commits} + * Learn more at {@link https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits} * Tags: dependency-graph */ export async function dependencyGraphDiffRange( @@ -91584,7 +95588,7 @@ export async function dependencyGraphExportSbom( * Create a snapshot of dependencies for a repository * Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope * to use this endpoint for a repository that the requesting user has access to. - * Learn more at {@link https://docs.github.com/rest/reference/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository} * Tags: dependency-graph */ export async function dependencyGraphCreateRepositorySnapshot( @@ -91699,7 +95703,8 @@ export async function reposListDeployments( * Users with `repo` or `repo_deployment` * scopes can create a deployment for a given ref. * - * #### Merged branch response + * Merged branch response: + * * You will see this response when GitHub * automatically merges the base branch into the topic branch instead of creating * a deployment. This auto-merge happens @@ -91713,18 +95718,20 @@ export async function reposListDeployments( * the base branch, a new request to create a deployment should give a successful * response. * - * #### Merge conflict - * response - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), - * can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * #### - * Failed commit status checks - * This error happens when the `required_contexts` parameter indicates that one or more - * contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not - * have a state of `success`. + * Merge conflict response: + * + * This + * error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be + * merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * Failed commit + * status checks: + * + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to + * have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of + * `success`. * Learn more at {@link https://docs.github.com/rest/deployments/deployments#create-a-deployment} * Tags: repos */ @@ -91834,7 +95841,7 @@ export async function reposGetDeployment( * * For more information, see "[Create a * deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment - * status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)." + * status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." * Learn more at {@link https://docs.github.com/rest/deployments/deployments#delete-a-deployment} * Tags: repos */ @@ -91890,7 +95897,7 @@ export async function reposListDeploymentStatuses( * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` - * access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the + * access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the * `repo_deployment` scope. * Learn more at {@link https://docs.github.com/rest/deployments/statuses#create-a-deployment-status} * Tags: repos @@ -91927,9 +95934,9 @@ export async function reposCreateDeploymentStatus( */ description?: string; /** - * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */ - environment?: 'production' | 'staging' | 'qa'; + environment?: string; /** * Sets the URL for accessing your environment. Default: `""` */ @@ -92001,7 +96008,7 @@ export async function reposGetDeploymentStatus( * * This input example * shows how you can use the `client_payload` as a test to debug your workflow. - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event} + * Learn more at {@link https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event} * Tags: repos */ export async function reposCreateDispatchEvent( @@ -92119,11 +96126,11 @@ export async function reposGetEnvironment( * patterns that branches must match in order to deploy to this environment, see "[Deployment branch * policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see - * "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub + * Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use - * this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. * Learn more at {@link https://docs.github.com/rest/deployments/environments#create-or-update-an-environment} * Tags: repos */ @@ -92136,6 +96143,7 @@ export async function reposCreateOrUpdateEnvironment( }, body: { wait_timer?: WaitTimer; + prevent_self_review?: PreventSelfReview; /** * The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ @@ -92226,12 +96234,12 @@ export async function reposListDeploymentBranchPolicies( } /** * Create a deployment branch policy - * Creates a deployment branch policy for an environment. + * Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy} + * You must authenticate using an access token with the + * `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use + * this endpoint. + * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy} * Tags: repos */ export async function reposCreateDeploymentBranchPolicy( @@ -92241,7 +96249,7 @@ export async function reposCreateDeploymentBranchPolicy( repo: string; environment_name: string; }, - body: DeploymentBranchPolicyNamePattern, + body: DeploymentBranchPolicyNamePatternWithType, opts?: FetcherData, ): Promise { const req = await ctx.createRequest({ @@ -92255,12 +96263,12 @@ export async function reposCreateDeploymentBranchPolicy( } /** * Get a deployment branch policy - * Gets a deployment branch policy for an environment. + * Gets a deployment branch or tag policy for an environment. * - * 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. - * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy} + * 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. + * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy} * Tags: repos */ export async function reposGetDeploymentBranchPolicy( @@ -92283,12 +96291,12 @@ export async function reposGetDeploymentBranchPolicy( } /** * Update a deployment branch policy - * Updates a deployment branch policy for an environment. + * Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy} + * You must authenticate using an access token with the + * `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use + * this endpoint. + * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy} * Tags: repos */ export async function reposUpdateDeploymentBranchPolicy( @@ -92313,12 +96321,12 @@ export async function reposUpdateDeploymentBranchPolicy( } /** * Delete a deployment branch policy - * Deletes a deployment branch policy for an environment. + * Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this - * endpoint. - * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy} + * You must authenticate using an access token with the + * `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use + * this endpoint. + * Learn more at {@link https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy} * Tags: repos */ export async function reposDeleteDeploymentBranchPolicy( @@ -92350,7 +96358,7 @@ export async function reposDeleteDeploymentBranchPolicy( * For * more information about the app that is providing this custom deployment rule, see the [documentation for the `GET * /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). - * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules} + * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment} * Tags: repos */ export async function reposGetAllDeploymentProtectionRules( @@ -92388,7 +96396,7 @@ export async function reposGetAllDeploymentProtectionRules( * For more information about the * app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` * endpoint](https://docs.github.com/rest/apps/apps#get-an-app). - * Learn more at {@link https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule} + * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment} * Tags: repos */ export async function reposCreateDeploymentProtectionRule( @@ -92429,7 +96437,7 @@ export async function reposCreateDeploymentProtectionRule( * For * more information about the app that is providing this custom deployment rule, see "[GET an * app](https://docs.github.com/rest/apps/apps#get-an-app)". - * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations} + * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment} * Tags: repos */ export async function reposListCustomDeploymentRuleIntegrations( @@ -92470,7 +96478,7 @@ export async function reposListCustomDeploymentRuleIntegrations( * For * more information about the app that is providing this custom deployment rule, see [`GET * /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). - * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule} + * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule} * Tags: repos */ export async function reposGetCustomDeploymentProtectionRule( @@ -92499,7 +96507,7 @@ export async function reposGetCustomDeploymentProtectionRule( * `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the * repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get * an app](https://docs.github.com/rest/apps/apps#get-an-app)". - * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule} + * Learn more at {@link https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment} * Tags: repos */ export async function reposDisableDeploymentProtectionRule( @@ -92524,7 +96532,7 @@ export async function reposDisableDeploymentProtectionRule( * List repository events * **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be * anywhere from 30s to 6h. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repository-events} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-repository-events} * Tags: activity */ export async function activityListRepoEvents( @@ -92550,7 +96558,7 @@ export async function activityListRepoEvents( } /** * List forks - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-forks} + * Learn more at {@link https://docs.github.com/rest/repos/forks#list-forks} * Tags: repos */ export async function reposListForks( @@ -92588,7 +96596,7 @@ export async function reposListForks( * **Note**: Although this endpoint works with * GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the * source account with access to the source repository. - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-a-fork} + * Learn more at {@link https://docs.github.com/rest/repos/forks#create-a-fork} * Tags: repos */ export async function reposCreateFork( @@ -92626,7 +96634,7 @@ export async function reposCreateFork( } /** * Create a blob - * Learn more at {@link https://docs.github.com/rest/reference/git#create-a-blob} + * Learn more at {@link https://docs.github.com/rest/git/blobs#create-a-blob} * Tags: git */ export async function gitCreateBlob( @@ -92663,7 +96671,7 @@ export async function gitCreateBlob( * * _Note_: This API supports blobs up to 100 megabytes in * size. - * Learn more at {@link https://docs.github.com/rest/reference/git#get-a-blob} + * Learn more at {@link https://docs.github.com/rest/git/blobs#get-a-blob} * Tags: git */ export async function gitGetBlob( @@ -92685,33 +96693,33 @@ export async function gitGetBlob( } /** * Create a commit - * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature - * verification object** + * **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: + * The response will include a `verification` object that describes the result of verifying the commit's + * signature. The following fields are included in the `verification` object: * * | Name | Type | Description | - * | - * ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit - * to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are - * enumerated in the table below. | + * | ---- | ---- + * | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be + * verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in + * the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | - * | - * `payload` | `string` | The value that was signed. | + * | `payload` | `string` + * | The value that was signed. | * - * These are the possible values for `reason` in the `verification` - * object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | + * | Value | + * Description | * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. + * | `expired_key` | The key that made the signature is expired. | * | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | * | * `gpgverify_error` | There was an error communicating with the signature verification service. | * | @@ -92733,7 +96741,7 @@ export async function gitGetBlob( * cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors * applied, so the signature is considered to be verified. | - * Learn more at {@link https://docs.github.com/rest/reference/git#create-a-commit} + * Learn more at {@link https://docs.github.com/rest/git/commits#create-a-commit} * Tags: git */ export async function gitCreateCommit( @@ -92810,6 +96818,7 @@ export async function gitCreateCommit( /** * Get a commit object * Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + * * To get the contents of a commit, * see "[Get a commit](/rest/commits/commits#get-a-commit)." * @@ -92858,7 +96867,7 @@ export async function gitCreateCommit( * `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. * | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - * Learn more at {@link https://docs.github.com/rest/reference/git#get-a-commit} + * Learn more at {@link https://docs.github.com/rest/git/commits#get-a-commit-object} * Tags: git */ export async function gitGetCommit( @@ -92891,14 +96900,14 @@ export async function gitGetCommit( * they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * * **Note:** You need to - * explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test - * merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull + * explicitly [request a pull request](https://docs.github.com/rest/pulls/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`. - * Learn more at {@link https://docs.github.com/rest/reference/git#list-matching-references} + * Learn more at {@link https://docs.github.com/rest/git/refs#list-matching-references} * Tags: git */ export async function gitListMatchingRefs( @@ -92924,11 +96933,11 @@ export async function gitListMatchingRefs( * branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** - * You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to - * trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking - * mergeability of pull + * You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/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)". - * Learn more at {@link https://docs.github.com/rest/reference/git#get-a-reference} + * Learn more at {@link https://docs.github.com/rest/git/refs#get-a-reference} * Tags: git */ export async function gitGetRef( @@ -92952,7 +96961,7 @@ export async function gitGetRef( * Create a reference * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the * commit SHA-1 hash used exists. Empty repositories are repositories without branches. - * Learn more at {@link https://docs.github.com/rest/reference/git#create-a-reference} + * Learn more at {@link https://docs.github.com/rest/git/refs#create-a-reference} * Tags: git */ export async function gitCreateRef( @@ -92984,7 +96993,7 @@ export async function gitCreateRef( } /** * Update a reference - * Learn more at {@link https://docs.github.com/rest/reference/git#update-a-reference} + * Learn more at {@link https://docs.github.com/rest/git/refs#update-a-reference} * Tags: git */ export async function gitUpdateRef( @@ -93017,7 +97026,7 @@ export async function gitUpdateRef( } /** * Delete a reference - * Learn more at {@link https://docs.github.com/rest/reference/git#delete-a-reference} + * Learn more at {@link https://docs.github.com/rest/git/refs#delete-a-reference} * Tags: git */ export async function gitDeleteRef( @@ -93041,9 +97050,9 @@ export async function gitDeleteRef( * Create a tag object * 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. + * [create](https://docs.github.com/rest/git/refs#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/git/refs#create-a-reference) the tag + * reference - this call would be unnecessary. * * **Signature verification object** * @@ -93090,7 +97099,7 @@ export async function gitDeleteRef( * `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. * | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - * Learn more at {@link https://docs.github.com/rest/reference/git#create-a-tag-object} + * Learn more at {@link https://docs.github.com/rest/git/tags#create-a-tag-object} * Tags: git */ export async function gitCreateTag( @@ -93192,7 +97201,7 @@ export async function gitCreateTag( * cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors * applied, so the signature is considered to be verified. | - * Learn more at {@link https://docs.github.com/rest/reference/git#get-a-tag} + * Learn more at {@link https://docs.github.com/rest/git/tags#get-a-tag} * Tags: git */ export async function gitGetTag( @@ -93220,12 +97229,12 @@ export async function gitGetTag( * 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)." + * commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a + * reference](https://docs.github.com/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a - * file that does not exist. - * Learn more at {@link https://docs.github.com/rest/reference/git#create-a-tree} + * Returns an error if you try to delete a file + * that does not exist. + * Learn more at {@link https://docs.github.com/rest/git/trees#create-a-tree} * Tags: git */ export async function gitCreateTree( @@ -93283,16 +97292,16 @@ export async function gitCreateTree( } /** * Get a tree - * Returns a single tree using the SHA1 value for that tree. + * Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of - * items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of - * fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the + * number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive + * method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a - * maximum size of 7 MB when using the `recursive` parameter. - * Learn more at {@link https://docs.github.com/rest/reference/git#get-a-tree} + * **Note**: The limit for the `tree` array is 100,000 + * entries with a maximum size of 7 MB when using the `recursive` parameter. + * Learn more at {@link https://docs.github.com/rest/git/trees#get-a-tree} * Tags: git */ export async function gitGetTree( @@ -93317,7 +97326,7 @@ export async function gitGetTree( /** * List repository webhooks * Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#list-repository-webhooks} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#list-repository-webhooks} * Tags: repos */ export async function reposListWebhooks( @@ -93346,7 +97355,7 @@ export async function reposListWebhooks( * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks * can * share the same `config` as long as those webhooks do not have any `events` that overlap. - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#create-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook} * Tags: repos */ export async function reposCreateWebhook( @@ -93361,7 +97370,7 @@ export async function reposCreateWebhook( */ name?: string; /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). + * Key/value pairs to provide settings for this webhook. */ config?: { url?: WebhookConfigUrl; @@ -93407,8 +97416,8 @@ export async function reposCreateWebhook( /** * Get a repository webhook * 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)." - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook} + * configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook} * Tags: repos */ export async function reposGetWebhook( @@ -93435,8 +97444,8 @@ export async function reposGetWebhook( * 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)." - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook} + * repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook} * Tags: repos */ export async function reposUpdateWebhook( @@ -93448,7 +97457,7 @@ export async function reposUpdateWebhook( }, body: { /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). + * Key/value pairs to provide settings for this webhook. */ config?: { url: WebhookConfigUrl; @@ -93501,7 +97510,7 @@ export async function reposUpdateWebhook( } /** * Delete a repository webhook - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#delete-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook} * Tags: repos */ export async function reposDeleteWebhook( @@ -93524,11 +97533,11 @@ export async function reposDeleteWebhook( /** * Get a webhook configuration for a repository * 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)." + * state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#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. - * Learn more at {@link https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository} * Tags: repos */ export async function reposGetWebhookConfigForRepo( @@ -93551,12 +97560,12 @@ export async function reposGetWebhookConfigForRepo( /** * Update a webhook configuration for a repository * 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)." + * state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#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. - * Learn more at {@link https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository} * Tags: repos */ export async function reposUpdateWebhookConfigForRepo( @@ -93586,7 +97595,7 @@ export async function reposUpdateWebhookConfigForRepo( /** * List deliveries for a repository webhook * Returns a list of webhook deliveries for a webhook configured in a repository. - * Learn more at {@link https://docs.github.com/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook} * Tags: repos */ export async function reposListWebhookDeliveries( @@ -93617,7 +97626,7 @@ export async function reposListWebhookDeliveries( /** * Get a delivery for a repository webhook * Returns a delivery for a webhook configured in a repository. - * Learn more at {@link https://docs.github.com/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook} * Tags: repos */ export async function reposGetWebhookDelivery( @@ -93643,7 +97652,7 @@ export async function reposGetWebhookDelivery( /** * Redeliver a delivery for a repository webhook * Redeliver a webhook delivery for a webhook configured in a repository. - * Learn more at {@link https://docs.github.com/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook} * Tags: repos */ export async function reposRedeliverWebhookDelivery( @@ -93667,7 +97676,7 @@ export async function reposRedeliverWebhookDelivery( /** * Ping a repository webhook * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#ping-a-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook} * Tags: repos */ export async function reposPingWebhook( @@ -93694,7 +97703,7 @@ export async function reposPingWebhook( * generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - * Learn more at {@link https://docs.github.com/rest/webhooks/repos#test-the-push-repository-webhook} + * Learn more at {@link https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook} * Tags: repos */ export async function reposTestPushWebhook( @@ -93718,35 +97727,32 @@ export async function reposTestPushWebhook( * Get an import status * View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version - * Control repositories will end - * on October 17, 2023. For more details, see - * [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect - * relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint + * is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see + * the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * - * This - * section includes details about the possible values of the `status` field of the Import Progress response. - * - * An import - * that does not have errors will progress through these steps: - * - * * `detecting` - the "detection" step of the import is in - * progress because the request did not include a `vcs` parameter. The import is identifying the type of source control - * present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched - * from the original repository. The import progress response will include `commit_count` (the total number of raw commits - * that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" - * step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates - * are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the - * import is in progress. This is where the importer updates the repository on GitHub. The import progress response will - * include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - - * the import is complete, and the repository is ready on GitHub. + * This section includes details about + * the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will + * progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request + * did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * + * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original + * repository. The import progress response will include `commit_count` (the total number of raw commits that will be + * imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the + * import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. + * The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in + * progress. This is where the importer updates the repository on GitHub. The import progress response will include + * `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the + * import is complete, and the repository is ready on GitHub. * * If there are problems, you will see one of these in the * `status` field: @@ -93791,6 +97797,7 @@ export async function reposTestPushWebhook( * originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating * repository. To see a list of these files, make a "Get Large Files" request. + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#get-an-import-status} * Tags: migrations */ @@ -93812,12 +97819,16 @@ export async function migrationsGetImportStatus( } /** * Start an import - * Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub - * Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for - * importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more - * details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to - * reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub + * Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very + * low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 + * UTC on April 12, 2024. For more details and alternatives, see the + * [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#start-an-import} * Tags: migrations */ @@ -93873,12 +97884,10 @@ export async function migrationsStartImport( * You can select the project to import by providing * one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, - * Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see - * [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect - * relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage + * and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, + * 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#update-an-import} * Tags: migrations */ @@ -93923,12 +97932,10 @@ export async function migrationsUpdateImport( * Cancel an import * Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version - * Control repositories will end - * on October 17, 2023. For more details, see - * [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect - * relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint + * is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see + * the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#cancel-an-import} * Tags: migrations */ @@ -93959,12 +97966,10 @@ export async function migrationsCancelImport( * author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide * correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version - * Control repositories will end - * on October 17, 2023. For more details, see - * [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect - * relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint + * is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see + * the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#get-commit-authors} * Tags: migrations */ @@ -93992,12 +97997,10 @@ export async function migrationsGetCommitAuthors( * new * commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control - * repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). - * In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators - * using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is + * deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the + * [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#map-a-commit-author} * Tags: migrations */ @@ -94033,12 +98036,10 @@ export async function migrationsMapCommitAuthor( * Get large files * List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team - * Foundation Version Control repositories will end - * on October 17, 2023. For more details, see - * [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect - * relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available + * alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more + * details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#get-large-files} * Tags: migrations */ @@ -94068,12 +98069,11 @@ export async function migrationsGetLargeFiles( * our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for - * importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more - * details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to - * reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very + * low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 + * UTC on April 12, 2024. For more details and alternatives, see the + * [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated * Learn more at {@link https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference} * Tags: migrations */ @@ -94108,7 +98108,7 @@ export async function migrationsSetLfsPreference( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app} * Tags: apps */ export async function appsGetRepoInstallation( @@ -94133,7 +98133,7 @@ export async function appsGetRepoInstallation( * Get interaction restrictions for a repository * Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no * restrictions, you will see an empty response. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository} * Tags: interactions */ export async function interactionsGetRestrictionsForRepo( @@ -94164,7 +98164,7 @@ export async function interactionsGetRestrictionsForRepo( * admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this * repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the * interaction limit for a single repository. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository} * Tags: interactions */ export async function interactionsSetRestrictionsForRepo( @@ -94195,7 +98195,7 @@ export async function interactionsSetRestrictionsForRepo( * restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a * `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single * repository. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository} * Tags: interactions */ export async function interactionsRemoveRestrictionsForRepo( @@ -94308,8 +98308,8 @@ export async function reposDeleteInvitation( * the `pull_request` key. Be aware that the `id` of a pull * request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull - * requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-repository-issues} + * requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * Learn more at {@link https://docs.github.com/rest/issues/issues#list-repository-issues} * Tags: issues */ export async function issuesListForRepo( @@ -94367,7 +98367,7 @@ export async function issuesListForRepo( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/issues#create-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/issues#create-an-issue} * Tags: issues */ export async function issuesCreate( @@ -94426,7 +98426,7 @@ export async function issuesCreate( * but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository} * Tags: issues */ export async function issuesListCommentsForRepo( @@ -94457,7 +98457,7 @@ export async function issuesListCommentsForRepo( * Get an issue comment * You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every * issue is a pull request. - * Learn more at {@link https://docs.github.com/rest/reference/issues#get-an-issue-comment} + * Learn more at {@link https://docs.github.com/rest/issues/comments#get-an-issue-comment} * Tags: issues */ export async function issuesGetComment( @@ -94483,7 +98483,7 @@ export async function issuesGetComment( * Update an issue comment * You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every * issue is a pull request. - * Learn more at {@link https://docs.github.com/rest/reference/issues#update-an-issue-comment} + * Learn more at {@link https://docs.github.com/rest/issues/comments#update-an-issue-comment} * Tags: issues */ export async function issuesUpdateComment( @@ -94516,7 +98516,7 @@ export async function issuesUpdateComment( * Delete an issue comment * You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every * issue is a pull request. - * Learn more at {@link https://docs.github.com/rest/reference/issues#delete-an-issue-comment} + * Learn more at {@link https://docs.github.com/rest/issues/comments#delete-an-issue-comment} * Tags: issues */ export async function issuesDeleteComment( @@ -94538,8 +98538,8 @@ export async function issuesDeleteComment( } /** * List reactions for an issue comment - * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment} + * List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment} * Tags: reactions */ export async function reactionsListForIssueComment( @@ -94575,9 +98575,9 @@ export async function reactionsListForIssueComment( } /** * Create reaction for an issue comment - * Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP - * `200` status means that you already added the reaction type to this issue comment. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue-comment} + * Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response + * with an HTTP `200` status means that you already added the reaction type to this issue comment. + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment} * Tags: reactions */ export async function reactionsCreateForIssueComment( @@ -94589,7 +98589,7 @@ export async function reactionsCreateForIssueComment( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. */ content: | '+1' @@ -94621,8 +98621,8 @@ export async function reactionsCreateForIssueComment( * /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue - * comment](https://docs.github.com/rest/reference/issues#comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction} + * comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction} * Tags: reactions */ export async function reactionsDeleteForIssueComment( @@ -94646,7 +98646,7 @@ export async function reactionsDeleteForIssueComment( /** * List issue events for a repository * Lists events for a repository. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository} * Tags: issues */ export async function issuesListEventsForRepo( @@ -94673,7 +98673,7 @@ export async function issuesListEventsForRepo( /** * Get an issue event * Gets a single event by the event id. - * Learn more at {@link https://docs.github.com/rest/reference/issues#get-an-issue-event} + * Learn more at {@link https://docs.github.com/rest/issues/events#get-an-issue-event} * Tags: issues */ export async function issuesGetEvent( @@ -94717,9 +98717,8 @@ export async function issuesGetEvent( * the `pull_request` key. Be * aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the * pull - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" - * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/issues#get-an-issue} + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * Learn more at {@link https://docs.github.com/rest/issues/issues#get-an-issue} * Tags: issues */ export async function issuesGet( @@ -94744,7 +98743,7 @@ export async function issuesGet( /** * Update an issue * Issue owners and users with push access can edit an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#update-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/issues#update-an-issue} * Tags: issues */ export async function issuesUpdate( @@ -94810,7 +98809,7 @@ export async function issuesUpdate( /** * Add assignees to an issue * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - * Learn more at {@link https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue} * Tags: issues */ export async function issuesAddAssignees( @@ -94842,7 +98841,7 @@ export async function issuesAddAssignees( /** * Remove assignees from an issue * Removes one or more assignees from an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue} * Tags: issues */ export async function issuesRemoveAssignees( @@ -94879,7 +98878,7 @@ export async function issuesRemoveAssignees( * `204` status code with no content is returned. * * Otherwise a `404` status code is returned. - * Learn more at {@link https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue} + * Learn more at {@link https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue} * Tags: issues */ export async function issuesCheckUserCanBeAssignedToIssue( @@ -94906,7 +98905,7 @@ export async function issuesCheckUserCanBeAssignedToIssue( * issue is a pull request. * * Issue comments are ordered by ascending ID. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-issue-comments} + * Learn more at {@link https://docs.github.com/rest/issues/comments#list-issue-comments} * Tags: issues */ export async function issuesListComments( @@ -94948,7 +98947,7 @@ export async function issuesListComments( * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" * for * details. - * Learn more at {@link https://docs.github.com/rest/reference/issues#create-an-issue-comment} + * Learn more at {@link https://docs.github.com/rest/issues/comments#create-an-issue-comment} * Tags: issues */ export async function issuesCreateComment( @@ -94980,7 +98979,7 @@ export async function issuesCreateComment( /** * List issue events * Lists all events for an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-issue-events} + * Learn more at {@link https://docs.github.com/rest/issues/events#list-issue-events} * Tags: issues */ export async function issuesListEvents( @@ -95006,7 +99005,7 @@ export async function issuesListEvents( /** * List labels for an issue * Lists all labels for an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-labels-for-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/labels#list-labels-for-an-issue} * Tags: issues */ export async function issuesListLabelsOnIssue( @@ -95032,7 +99031,7 @@ export async function issuesListLabelsOnIssue( /** * Add labels to an issue * Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#add-labels-to-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/labels#add-labels-to-an-issue} * Tags: issues */ export async function issuesAddLabels( @@ -95045,7 +99044,7 @@ export async function issuesAddLabels( body: | { /** - * The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." + * The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; } @@ -95073,7 +99072,7 @@ export async function issuesAddLabels( /** * Set labels for an issue * Removes any previous labels and sets the new labels for an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#set-labels-for-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/labels#set-labels-for-an-issue} * Tags: issues */ export async function issuesSetLabels( @@ -95086,7 +99085,7 @@ export async function issuesSetLabels( body: | { /** - * The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." + * The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; } @@ -95114,7 +99113,7 @@ export async function issuesSetLabels( /** * Remove all labels from an issue * Removes all labels from an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue} * Tags: issues */ export async function issuesRemoveAllLabels( @@ -95138,7 +99137,7 @@ export async function issuesRemoveAllLabels( * Remove a label from an issue * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 * Not Found` status if the label does not exist. - * Learn more at {@link https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue} * Tags: issues */ export async function issuesRemoveLabel( @@ -95166,7 +99165,7 @@ export async function issuesRemoveLabel( * 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)." - * Learn more at {@link https://docs.github.com/rest/reference/issues#lock-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/issues#lock-an-issue} * Tags: issues */ export async function issuesLock( @@ -95200,7 +99199,7 @@ export async function issuesLock( /** * Unlock an issue * Users with push access can unlock an issue's conversation. - * Learn more at {@link https://docs.github.com/rest/reference/issues#unlock-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/issues#unlock-an-issue} * Tags: issues */ export async function issuesUnlock( @@ -95222,8 +99221,8 @@ export async function issuesUnlock( } /** * List reactions for an issue - * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue} + * List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue} * Tags: reactions */ export async function reactionsListForIssue( @@ -95259,9 +99258,9 @@ export async function reactionsListForIssue( } /** * Create reaction for an issue - * Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status - * means that you already added the reaction type to this issue. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue} + * Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` + * status means that you already added the reaction type to this issue. + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue} * Tags: reactions */ export async function reactionsCreateForIssue( @@ -95273,7 +99272,7 @@ export async function reactionsCreateForIssue( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. */ content: | '+1' @@ -95305,8 +99304,8 @@ export async function reactionsCreateForIssue( * /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an - * [issue](https://docs.github.com/rest/reference/issues/). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction} + * [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction} * Tags: reactions */ export async function reactionsDeleteForIssue( @@ -95330,7 +99329,7 @@ export async function reactionsDeleteForIssue( /** * List timeline events for an issue * List all timeline events for an issue. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue} + * Learn more at {@link https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue} * Tags: issues */ export async function issuesListEventsForTimeline( @@ -95359,7 +99358,7 @@ export async function issuesListEventsForTimeline( } /** * List deploy keys - * Learn more at {@link https://docs.github.com/rest/deploy-keys#list-deploy-keys} + * Learn more at {@link https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys} * Tags: repos */ export async function reposListDeployKeys( @@ -95384,7 +99383,7 @@ export async function reposListDeployKeys( /** * Create a deploy key * You can create a read-only deploy key. - * Learn more at {@link https://docs.github.com/rest/deploy-keys#create-a-deploy-key} + * Learn more at {@link https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key} * Tags: repos */ export async function reposCreateDeployKey( @@ -95422,7 +99421,7 @@ export async function reposCreateDeployKey( } /** * Get a deploy key - * Learn more at {@link https://docs.github.com/rest/deploy-keys#get-a-deploy-key} + * Learn more at {@link https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key} * Tags: repos */ export async function reposGetDeployKey( @@ -95445,7 +99444,7 @@ export async function reposGetDeployKey( /** * Delete a deploy key * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - * Learn more at {@link https://docs.github.com/rest/deploy-keys#delete-a-deploy-key} + * Learn more at {@link https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key} * Tags: repos */ export async function reposDeleteDeployKey( @@ -95468,7 +99467,7 @@ export async function reposDeleteDeployKey( /** * List labels for a repository * Lists all labels for a repository. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-labels-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/issues/labels#list-labels-for-a-repository} * Tags: issues */ export async function issuesListLabelsForRepo( @@ -95494,7 +99493,7 @@ export async function issuesListLabelsForRepo( * Create a label * Creates a label for the specified repository with the given name and color. The name and color parameters are required. * The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - * Learn more at {@link https://docs.github.com/rest/reference/issues#create-a-label} + * Learn more at {@link https://docs.github.com/rest/issues/labels#create-a-label} * Tags: issues */ export async function issuesCreateLabel( @@ -95531,7 +99530,7 @@ export async function issuesCreateLabel( /** * Get a label * Gets a label using the given name. - * Learn more at {@link https://docs.github.com/rest/reference/issues#get-a-label} + * Learn more at {@link https://docs.github.com/rest/issues/labels#get-a-label} * Tags: issues */ export async function issuesGetLabel( @@ -95554,7 +99553,7 @@ export async function issuesGetLabel( /** * Update a label * Updates a label using the given label name. - * Learn more at {@link https://docs.github.com/rest/reference/issues#update-a-label} + * Learn more at {@link https://docs.github.com/rest/issues/labels#update-a-label} * Tags: issues */ export async function issuesUpdateLabel( @@ -95592,7 +99591,7 @@ export async function issuesUpdateLabel( /** * Delete a label * Deletes a label using the given label name. - * Learn more at {@link https://docs.github.com/rest/reference/issues#delete-a-label} + * Learn more at {@link https://docs.github.com/rest/issues/labels#delete-a-label} * Tags: issues */ export async function issuesDeleteLabel( @@ -95616,7 +99615,7 @@ export async function issuesDeleteLabel( * List repository languages * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written * in that language. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repository-languages} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repository-languages} * Tags: repos */ export async function reposListLanguages( @@ -95635,59 +99634,15 @@ export async function reposListLanguages( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } -/** - * Enable Git LFS for a repository - * Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - * Learn more at {@link https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository} - * Tags: repos - */ -export async function reposEnableLfsForRepo( - ctx: r.Context, - params: { - owner: string; - repo: string; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/repos/{owner}/{repo}/lfs', - params, - method: r.HttpMethod.PUT, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} -/** - * Disable Git LFS for a repository - * Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - * Learn more at {@link https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository} - * Tags: repos - */ -export async function reposDisableLfsForRepo( - ctx: r.Context, - params: { - owner: string; - repo: string; - }, - opts?: FetcherData, -): Promise { - const req = await ctx.createRequest({ - path: '/repos/{owner}/{repo}/lfs', - params, - method: r.HttpMethod.DELETE, - }); - const res = await ctx.sendRequest(req, opts); - return ctx.handleResponse(res, {}); -} /** * Get the license for a repository * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository - * content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media + * content](https://docs.github.com/rest/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. - * Learn more at {@link https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository} * Tags: licenses */ export async function licensesGetForRepo( @@ -95774,7 +99729,7 @@ export async function reposMerge( /** * List milestones * Lists milestones for a repository. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-milestones} + * Learn more at {@link https://docs.github.com/rest/issues/milestones#list-milestones} * Tags: issues */ export async function issuesListMilestones( @@ -95804,7 +99759,7 @@ export async function issuesListMilestones( /** * Create a milestone * Creates a milestone. - * Learn more at {@link https://docs.github.com/rest/reference/issues#create-a-milestone} + * Learn more at {@link https://docs.github.com/rest/issues/milestones#create-a-milestone} * Tags: issues */ export async function issuesCreateMilestone( @@ -95848,7 +99803,7 @@ export async function issuesCreateMilestone( /** * Get a milestone * Gets a milestone using the given milestone number. - * Learn more at {@link https://docs.github.com/rest/reference/issues#get-a-milestone} + * Learn more at {@link https://docs.github.com/rest/issues/milestones#get-a-milestone} * Tags: issues */ export async function issuesGetMilestone( @@ -95872,7 +99827,7 @@ export async function issuesGetMilestone( } /** * Update a milestone - * Learn more at {@link https://docs.github.com/rest/reference/issues#update-a-milestone} + * Learn more at {@link https://docs.github.com/rest/issues/milestones#update-a-milestone} * Tags: issues */ export async function issuesUpdateMilestone( @@ -95917,7 +99872,7 @@ export async function issuesUpdateMilestone( /** * Delete a milestone * Deletes a milestone using the given milestone number. - * Learn more at {@link https://docs.github.com/rest/reference/issues#delete-a-milestone} + * Learn more at {@link https://docs.github.com/rest/issues/milestones#delete-a-milestone} * Tags: issues */ export async function issuesDeleteMilestone( @@ -95940,7 +99895,7 @@ export async function issuesDeleteMilestone( /** * List labels for issues in a milestone * Lists labels for issues in a milestone. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone} + * Learn more at {@link https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone} * Tags: issues */ export async function issuesListLabelsForMilestone( @@ -95966,7 +99921,7 @@ export async function issuesListLabelsForMilestone( /** * List repository notifications for the authenticated user * Lists all notifications for the current user in the specified repository. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user} * Tags: activity */ export async function activityListRepoNotificationsForAuthenticatedUser< @@ -96009,9 +99964,9 @@ export async function activityListRepoNotificationsForAuthenticatedUser< * 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`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read} + * user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) + * endpoint and pass the query parameter `all=false`. + * Learn more at {@link https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read} * Tags: activity */ export async function activityMarkRepoNotificationsAsRead( @@ -96049,7 +100004,7 @@ export async function activityMarkRepoNotificationsAsRead( * * A token with the `repo` scope is required. GitHub Apps must have the * `pages:read` permission. - * Learn more at {@link https://docs.github.com/rest/pages#get-a-github-pages-site} + * Learn more at {@link https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site} * Tags: repos */ export async function reposGetPages( @@ -96078,7 +100033,7 @@ export async function reposGetPages( * To use this endpoint, you must be a repository * administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages * write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. - * Learn more at {@link https://docs.github.com/rest/pages#create-a-github-pages-site} + * Learn more at {@link https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site} * Tags: repos */ export async function reposCreatePagesSite( @@ -96109,7 +100064,7 @@ export async function reposCreatePagesSite( * To use this endpoint, you must be a repository * administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages * write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. - * Learn more at {@link https://docs.github.com/rest/pages#update-information-about-a-github-pages-site} + * Learn more at {@link https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site} * Tags: repos */ export async function reposUpdateInformationAboutPagesSite( @@ -96138,7 +100093,7 @@ export async function reposUpdateInformationAboutPagesSite( * To use this endpoint, you must be a repository * administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages * write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. - * Learn more at {@link https://docs.github.com/rest/pages#delete-a-github-pages-site} + * Learn more at {@link https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site} * Tags: repos */ export async function reposDeletePagesSite( @@ -96163,7 +100118,7 @@ export async function reposDeletePagesSite( * * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` * permission. - * Learn more at {@link https://docs.github.com/rest/pages#list-github-pages-builds} + * Learn more at {@link https://docs.github.com/rest/pages/pages#list-apiname-pages-builds} * Tags: repos */ export async function reposListPagesBuilds( @@ -96196,7 +100151,7 @@ export async function reposListPagesBuilds( * Build requests are limited to one concurrent build per * repository and one concurrent build per requester. If you request a build while another is still in progress, the second * request will be queued until the first completes. - * Learn more at {@link https://docs.github.com/rest/pages#request-a-github-pages-build} + * Learn more at {@link https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build} * Tags: repos */ export async function reposRequestPagesBuild( @@ -96221,7 +100176,7 @@ export async function reposRequestPagesBuild( * * A token with the `repo` scope is required. * GitHub Apps must have the `pages:read` permission. - * Learn more at {@link https://docs.github.com/rest/pages#get-latest-pages-build} + * Learn more at {@link https://docs.github.com/rest/pages/pages#get-latest-pages-build} * Tags: repos */ export async function reposGetLatestPagesBuild( @@ -96248,7 +100203,7 @@ export async function reposGetLatestPagesBuild( * * A token with the `repo` scope is required. GitHub Apps must have the * `pages:read` permission. - * Learn more at {@link https://docs.github.com/rest/pages#get-github-pages-build} + * Learn more at {@link https://docs.github.com/rest/pages/pages#get-apiname-pages-build} * Tags: repos */ export async function reposGetPagesBuild( @@ -96276,7 +100231,7 @@ export async function reposGetPagesBuild( * * Users must have write permissions. GitHub Apps must have the * `pages:write` permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/pages#create-a-github-pages-deployment} + * Learn more at {@link https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment} * Tags: repos */ export async function reposCreatePagesDeployment( @@ -96328,7 +100283,7 @@ export async function reposCreatePagesDeployment( * To use this endpoint, you must be a repository administrator, maintainer, or * have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. * GitHub Apps must have the `administrative:write` and `pages:write` permissions. - * Learn more at {@link https://docs.github.com/rest/pages#get-a-dns-health-check-for-github-pages} + * Learn more at {@link https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages} * Tags: repos */ export async function reposGetPagesHealthCheck( @@ -96347,11 +100302,59 @@ export async function reposGetPagesHealthCheck( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + * Enable private vulnerability reporting for a repository + * Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the + * repository. For more information, see "[Privately reporting a security + * vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + * Learn more at {@link https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository} + * Tags: repos + */ +export async function reposEnablePrivateVulnerabilityReporting( + ctx: r.Context, + params: { + owner: string; + repo: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/private-vulnerability-reporting', + params, + method: r.HttpMethod.PUT, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + * Disable private vulnerability reporting for a repository + * Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the + * repository. For more information, see "[Privately reporting a security + * vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + * Learn more at {@link https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository} + * Tags: repos + */ +export async function reposDisablePrivateVulnerabilityReporting( + ctx: r.Context, + params: { + owner: string; + repo: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/private-vulnerability-reporting', + params, + method: r.HttpMethod.DELETE, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List repository projects * Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you * do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-repository-projects} + * Learn more at {@link https://docs.github.com/rest/projects/projects#list-repository-projects} * Tags: projects */ export async function projectsListForRepo( @@ -96381,7 +100384,7 @@ export async function projectsListForRepo( * Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the * repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a * `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#create-a-repository-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#create-a-repository-project} * Tags: projects */ export async function projectsCreateForRepo( @@ -96413,13 +100416,37 @@ export async function projectsCreateForRepo( '201': { transforms: { date: [[['ref', $date_Project]]] } }, }); } +/** + * Get all custom property values for a repository + * Gets all custom property values that are set for a repository. + * Users with read access to the repository can use this + * endpoint. + * Learn more at {@link https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository} + * Tags: repos + */ +export async function reposGetCustomPropertiesValues( + ctx: r.Context, + params: { + owner: string; + repo: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/properties/values', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List pull requests * 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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-pull-requests} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#list-pull-requests} * Tags: pulls */ export async function pullsList( @@ -96476,7 +100503,7 @@ export async function pullsList( * limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with * secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#create-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#create-a-pull-request} * Tags: pulls */ export async function pullsCreate( @@ -96537,7 +100564,7 @@ export async function pullsCreate( /** * List review comments in a repository * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository} * Tags: pulls */ export async function pullsListReviewCommentsForRepo( @@ -96571,7 +100598,7 @@ export async function pullsListReviewCommentsForRepo( /** * Get a review comment for a pull request * Provides details for a review comment. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request} * Tags: pulls */ export async function pullsGetReviewComment( @@ -96598,7 +100625,7 @@ export async function pullsGetReviewComment( /** * Update a review comment for a pull request * Enables you to edit a review comment. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request} * Tags: pulls */ export async function pullsUpdateReviewComment( @@ -96632,7 +100659,7 @@ export async function pullsUpdateReviewComment( /** * Delete a review comment for a pull request * Deletes a review comment. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request} * Tags: pulls */ export async function pullsDeleteReviewComment( @@ -96654,8 +100681,9 @@ export async function pullsDeleteReviewComment( } /** * List reactions for a pull request review comment - * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment} + * List the reactions to a [pull request review + * comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment} * Tags: reactions */ export async function reactionsListForPullRequestReviewComment( @@ -96691,9 +100719,10 @@ export async function reactionsListForPullRequestReviewComment( } /** * Create reaction for a pull request review comment - * Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response - * with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - * Learn more at {@link https://docs.github.com/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment} + * Create a reaction to a [pull request review + * comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP + * `200` status means that you already added the reaction type to this pull request review comment. + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment} * Tags: reactions */ export async function reactionsCreateForPullRequestReviewComment( @@ -96705,7 +100734,7 @@ export async function reactionsCreateForPullRequestReviewComment( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. */ content: | '+1' @@ -96737,8 +100766,8 @@ export async function reactionsCreateForPullRequestReviewComment( * /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request - * review comment](https://docs.github.com/rest/reference/pulls#review-comments). - * Learn more at {@link https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction} + * review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction} * Tags: reactions */ export async function reactionsDeleteForPullRequestComment( @@ -96770,9 +100799,9 @@ export async function reactionsDeleteForPullRequestComment( * Lists details of a pull request by providing its number. * * When you get, - * [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or - * [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit - * to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the + * [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or + * [edit](https://docs.github.com/rest/pulls/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)". @@ -96801,7 +100830,7 @@ export async function reactionsDeleteForPullRequestComment( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#get-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#get-a-pull-request} * Tags: pulls */ export async function pullsGet( @@ -96834,7 +100863,7 @@ export async function pullsGet( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls/#update-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#update-a-pull-request} * Tags: pulls */ export async function pullsUpdate( @@ -96888,7 +100917,7 @@ export async function pullsUpdate( * * GitHub Apps must have write access to the `codespaces` * repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request} * Tags: codespaces */ export async function codespacesCreateWithPrForAuthenticatedUser( @@ -96957,7 +100986,7 @@ export async function codespacesCreateWithPrForAuthenticatedUser( /** * List review comments on a pull request * Lists all review comments for a pull request. By default, review comments are in ascending order by ID. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request} * Tags: pulls */ export async function pullsListReviewComments( @@ -96992,7 +101021,7 @@ export async function pullsListReviewComments( /** * Create a review comment for a pull request * 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 + * issue comment](https://docs.github.com/rest/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. * @@ -97011,7 +101040,7 @@ export async function pullsListReviewComments( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request} * Tags: pulls */ export async function pullsCreateReviewComment( @@ -97063,7 +101092,7 @@ export async function pullsCreateReviewComment( /** * The level at which the comment is targeted. */ - subject_type?: 'LINE' | 'FILE'; + subject_type?: 'line' | 'file'; }, opts?: FetcherData, ): Promise { @@ -97093,7 +101122,7 @@ export async function pullsCreateReviewComment( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment} + * Learn more at {@link https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment} * Tags: pulls */ export async function pullsCreateReplyForReviewComment( @@ -97128,8 +101157,8 @@ export async function pullsCreateReplyForReviewComment( /** * List commits on a pull request * 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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request} + * 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request} * Tags: pulls */ export async function pullsListCommits( @@ -97155,7 +101184,7 @@ export async function pullsListCommits( /** * List pull requests files * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-pull-requests-files} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#list-pull-requests-files} * Tags: pulls */ export async function pullsListFiles( @@ -97182,7 +101211,7 @@ export async function pullsListFiles( * Check if a pull request has been merged * Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not * the pull request has been merged; the response body is empty. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged} * Tags: pulls */ export async function pullsCheckIfMerged( @@ -97212,7 +101241,7 @@ export async function pullsCheckIfMerged( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#merge-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#merge-a-pull-request} * Tags: pulls */ export async function pullsMerge( @@ -97256,7 +101285,7 @@ export async function pullsMerge( * Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they * are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull * request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request} * Tags: pulls */ export async function pullsListRequestedReviewers( @@ -97286,7 +101315,7 @@ export async function pullsListRequestedReviewers( * secondary rate * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request} * Tags: pulls */ export async function pullsRequestReviewers( @@ -97313,7 +101342,7 @@ export async function pullsRequestReviewers( /** * Remove requested reviewers from a pull request * Removes review requests from a pull request for a given set of users and/or teams. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request} * Tags: pulls */ export async function pullsRemoveRequestedReviewers( @@ -97349,7 +101378,7 @@ export async function pullsRemoveRequestedReviewers( /** * List reviews for a pull request * The list of reviews returns in chronological order. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request} * Tags: pulls */ export async function pullsListReviews( @@ -97389,20 +101418,20 @@ export async function pullsListReviews( * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the * `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter * blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull - * request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific - * line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the - * `application/vnd.github.v3.diff` [media + * **Note:** To comment on a + * specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers + * the `application/vnd.github.v3.diff` [media * type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull * request diff, add this media type to the `Accept` header of a call to the [single pull - * request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint. + * request](https://docs.github.com/rest/pulls/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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request} + * 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. + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request} * Tags: pulls */ export async function pullsCreateReview( @@ -97422,7 +101451,7 @@ export async function pullsCreateReview( */ body?: string; /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready. + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. */ event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT'; /** @@ -97475,7 +101504,7 @@ export async function pullsCreateReview( /** * Get a review for a pull request * Retrieves a pull request review by its ID. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request} * Tags: pulls */ export async function pullsGetReview( @@ -97501,7 +101530,7 @@ export async function pullsGetReview( /** * Update a review for a pull request * Update the review summary comment with new text. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request} * Tags: pulls */ export async function pullsUpdateReview( @@ -97534,7 +101563,7 @@ export async function pullsUpdateReview( /** * Delete a pending review for a pull request * Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request} + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request} * Tags: pulls */ export async function pullsDeletePendingReview( @@ -97560,7 +101589,7 @@ export async function pullsDeletePendingReview( /** * List comments for a pull request review * List comments for a specific pull request review. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review} + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review} * Tags: pulls */ export async function pullsListCommentsForReview( @@ -97589,9 +101618,9 @@ export async function pullsListCommentsForReview( /** * Dismiss a review for a pull request * **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. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request} + * branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included + * in the list of people or teams who can dismiss pull request reviews. + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request} * Tags: pulls */ export async function pullsDismissReview( @@ -97628,8 +101657,9 @@ export async function pullsDismissReview( /** * Submit a review for a pull request * Submits a pending review for a pull request. For more information about creating a pending review for a pull request, - * see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." - * Learn more at {@link https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request} + * see "[Create a review for a pull + * request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * Learn more at {@link https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request} * Tags: pulls */ export async function pullsSubmitReview( @@ -97667,7 +101697,7 @@ export async function pullsSubmitReview( * Update a pull request branch * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull * request branch. - * Learn more at {@link https://docs.github.com/rest/reference/pulls#update-a-pull-request-branch} + * Learn more at {@link https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch} * Tags: pulls */ export async function pullsUpdateBranch( @@ -97679,7 +101709,7 @@ export async function pullsUpdateBranch( }, body: { /** - * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null, @@ -97702,8 +101732,8 @@ export async function pullsUpdateBranch( * Gets the preferred README for a repository. * * READMEs support [custom media - * types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-repository-readme} + * types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * Learn more at {@link https://docs.github.com/rest/repos/contents#get-a-repository-readme} * Tags: repos */ export async function reposGetReadme( @@ -97729,8 +101759,8 @@ export async function reposGetReadme( * Gets the README from a repository directory. * * READMEs support [custom media - * types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme} + * types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * Learn more at {@link https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory} * Tags: repos */ export async function reposGetReadmeInDirectory( @@ -97756,11 +101786,11 @@ export async function reposGetReadmeInDirectory( * List releases * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. * To get a list of Git tags, use the [Repository Tags - * API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * API](https://docs.github.com/rest/repos/repos#list-repository-tags). * - * Information about published releases are - * available to everyone. Only users with push access will receive listings for draft releases. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-releases} + * Information about published releases are available + * to everyone. Only users with push access will receive listings for draft releases. + * Learn more at {@link https://docs.github.com/rest/releases/releases#list-releases} * Tags: repos */ export async function reposListReleases( @@ -97861,7 +101891,7 @@ export async function reposCreateRelease( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-release-asset} + * Learn more at {@link https://docs.github.com/rest/releases/assets#get-a-release-asset} * Tags: repos */ export async function reposGetReleaseAsset( @@ -97886,7 +101916,7 @@ export async function reposGetReleaseAsset( /** * Update a release asset * Users with push access to the repository can edit a release asset. - * Learn more at {@link https://docs.github.com/rest/reference/repos#update-a-release-asset} + * Learn more at {@link https://docs.github.com/rest/releases/assets#update-a-release-asset} * Tags: repos */ export async function reposUpdateReleaseAsset( @@ -97925,7 +101955,7 @@ export async function reposUpdateReleaseAsset( } /** * Delete a release asset - * Learn more at {@link https://docs.github.com/rest/reference/repos#delete-a-release-asset} + * Learn more at {@link https://docs.github.com/rest/releases/assets#delete-a-release-asset} * Tags: repos */ export async function reposDeleteReleaseAsset( @@ -97947,10 +101977,11 @@ export async function reposDeleteReleaseAsset( } /** * Generate release notes content for a release - * Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content - * will be markdown formatted and contain information like the changes since last release and users who contributed. The - * generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - * Learn more at {@link https://docs.github.com/rest/reference/repos#generate-release-notes} + * Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body + * content will be markdown formatted and contain information like the changes since last release and users who + * contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when + * creating a new release. + * Learn more at {@link https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release} * Tags: repos */ export async function reposGenerateReleaseNotes( @@ -97995,7 +102026,7 @@ export async function reposGenerateReleaseNotes( * The latest release is the most recent non-prerelease, * non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for * the release, and not the date when the release was drafted or published. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-the-latest-release} + * Learn more at {@link https://docs.github.com/rest/releases/releases#get-the-latest-release} * Tags: repos */ export async function reposGetLatestRelease( @@ -98019,7 +102050,7 @@ export async function reposGetLatestRelease( /** * Get a release by tag name * Get a published release with the specified tag. - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name} + * Learn more at {@link https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name} * Tags: repos */ export async function reposGetReleaseByTag( @@ -98045,7 +102076,7 @@ export async function reposGetReleaseByTag( * Get a release * **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). - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-a-release} + * Learn more at {@link https://docs.github.com/rest/releases/releases#get-a-release} * Tags: repos */ export async function reposGetRelease( @@ -98070,7 +102101,7 @@ export async function reposGetRelease( /** * Update a release * Users with push access to the repository can edit a release. - * Learn more at {@link https://docs.github.com/rest/reference/repos#update-a-release} + * Learn more at {@link https://docs.github.com/rest/releases/releases#update-a-release} * Tags: repos */ export async function reposUpdateRelease( @@ -98131,7 +102162,7 @@ export async function reposUpdateRelease( /** * Delete a release * Users with push access to the repository can delete a release. - * Learn more at {@link https://docs.github.com/rest/reference/repos#delete-a-release} + * Learn more at {@link https://docs.github.com/rest/releases/releases#delete-a-release} * Tags: repos */ export async function reposDeleteRelease( @@ -98153,7 +102184,7 @@ export async function reposDeleteRelease( } /** * List release assets - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-release-assets} + * Learn more at {@link https://docs.github.com/rest/releases/assets#list-release-assets} * Tags: repos */ export async function reposListReleaseAssets( @@ -98208,17 +102239,15 @@ export async function reposListReleaseAssets( * **Notes:** * * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing - * periods. The "[List assets for a - * release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" - * endpoint lists the renamed filenames. - * For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To - * find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` - * endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). - * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/repos#upload-a-release-asset} + * periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" + * endpoint lists + * the renamed filenames. For more information and help, contact [GitHub + * Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET + * /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). + * * 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. + * Learn more at {@link https://docs.github.com/rest/releases/assets#upload-a-release-asset} * Tags: repos */ export async function reposUploadReleaseAsset( @@ -98247,8 +102276,8 @@ export async function reposUploadReleaseAsset( } /** * List reactions for a release - * List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release} + * List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release} * Tags: reactions */ export async function reactionsListForRelease( @@ -98276,9 +102305,9 @@ export async function reactionsListForRelease( } /** * Create reaction for a release - * Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 - * OK` means that you already added the reaction type to this release. - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release} + * Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a + * `Status: 200 OK` means that you already added the reaction type to this release. + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release} * Tags: reactions */ export async function reactionsCreateForRelease( @@ -98290,7 +102319,7 @@ export async function reactionsCreateForRelease( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. */ content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes'; }, @@ -98314,8 +102343,8 @@ export async function reactionsCreateForRelease( * /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a - * [release](https://docs.github.com/rest/reference/repos#releases). - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#delete-a-release-reaction} + * [release](https://docs.github.com/rest/releases/releases#get-a-release). + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction} * Tags: reactions */ export async function reactionsDeleteForRelease( @@ -98338,11 +102367,13 @@ export async function reactionsDeleteForRelease( } /** * Get rules for a branch - * Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to - * a - * branch with that name will be returned. All rules that apply will be returned, regardless of the level at which - * they - * are configured. + * Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would + * apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the + * level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or + * "disabled" + * enforcement statuses are not returned. * Learn more at {@link https://docs.github.com/rest/repos/rules#get-rules-for-a-branch} * Tags: repos */ @@ -98356,7 +102387,7 @@ export async function reposGetBranchRules( page?: number; }, opts?: FetcherData, -): Promise { +): Promise { const req = await ctx.createRequest({ path: '/repos/{owner}/{repo}/rules/branches/{branch}', params, @@ -98369,7 +102400,7 @@ export async function reposGetBranchRules( /** * Get all repository rulesets * Get all the rulesets for a repository. - * Learn more at {@link https://docs.github.com/rest/repos/rules#get-repository-rulesets} + * Learn more at {@link https://docs.github.com/rest/repos/rules#get-all-repository-rulesets} * Tags: repos */ export async function reposGetRepoRulesets( @@ -98399,7 +102430,7 @@ export async function reposGetRepoRulesets( /** * Create a repository ruleset * Create a ruleset for a repository. - * Learn more at {@link https://docs.github.com/rest/repos/rules#create-repository-ruleset} + * Learn more at {@link https://docs.github.com/rest/repos/rules#create-a-repository-ruleset} * Tags: repos */ export async function reposCreateRepoRuleset( @@ -98418,10 +102449,6 @@ export async function reposCreateRepoRuleset( */ target?: 'branch' | 'tag'; enforcement: RepositoryRuleEnforcement; - /** - * The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing. - */ - bypass_mode?: 'none' | 'repository' | 'organization'; /** * The actors that can bypass the rules in this ruleset */ @@ -98445,10 +102472,78 @@ export async function reposCreateRepoRuleset( '201': { transforms: { date: [[['ref', $date_RepositoryRuleset]]] } }, }); } +/** + * List repository rule suites + * Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a + * repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * Learn more at {@link https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites} + * Tags: repos + */ +export async function reposGetRepoRuleSuites( + ctx: r.Context, + params: { + owner: string; + repo: string; + ref?: string; + time_period?: 'hour' | 'day' | 'week' | 'month'; + actor_name?: string; + rule_suite_result?: 'pass' | 'fail' | 'bypass' | 'all'; + per_page?: number; + page?: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/rulesets/rule-suites', + params, + method: r.HttpMethod.GET, + queryParams: [ + 'ref', + 'time_period', + 'actor_name', + 'rule_suite_result', + 'per_page', + 'page', + ], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_RuleSuites]]] } }, + }); +} +/** + * Get a repository rule suite + * Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing + * rulesets for a + * repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * Learn more at {@link https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite} + * Tags: repos + */ +export async function reposGetRepoRuleSuite( + ctx: r.Context, + params: { + owner: string; + repo: string; + rule_suite_id: number; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}', + params, + method: r.HttpMethod.GET, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, { + '200': { transforms: { date: [[['ref', $date_RuleSuite]]] } }, + }); +} /** * Get a repository ruleset * Get a ruleset for a repository. - * Learn more at {@link https://docs.github.com/rest/repos/rules#get-repository-ruleset} + * Learn more at {@link https://docs.github.com/rest/repos/rules#get-a-repository-ruleset} * Tags: repos */ export async function reposGetRepoRuleset( @@ -98475,7 +102570,7 @@ export async function reposGetRepoRuleset( /** * Update a repository ruleset * Update a ruleset for a repository. - * Learn more at {@link https://docs.github.com/rest/repos/rules#update-repository-ruleset} + * Learn more at {@link https://docs.github.com/rest/repos/rules#update-a-repository-ruleset} * Tags: repos */ export async function reposUpdateRepoRuleset( @@ -98495,10 +102590,6 @@ export async function reposUpdateRepoRuleset( */ target?: 'branch' | 'tag'; enforcement?: RepositoryRuleEnforcement; - /** - * The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing. - */ - bypass_mode?: 'none' | 'repository' | 'organization'; /** * The actors that can bypass the rules in this ruleset */ @@ -98525,7 +102616,7 @@ export async function reposUpdateRepoRuleset( /** * Delete a repository ruleset * Delete a ruleset for a repository. - * Learn more at {@link https://docs.github.com/rest/repos/rules#delete-repository-ruleset} + * Learn more at {@link https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset} * Tags: repos */ export async function reposDeleteRepoRuleset( @@ -98555,7 +102646,7 @@ export async function reposDeleteRepoRuleset( * scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository} * Tags: secret-scanning */ export async function secretScanningListAlertsForRepo( @@ -98608,7 +102699,7 @@ export async function secretScanningListAlertsForRepo( * scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert} * Tags: secret-scanning */ export async function secretScanningGetAlert( @@ -98640,7 +102731,7 @@ export async function secretScanningGetAlert( * scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert} * Tags: secret-scanning */ export async function secretScanningUpdateAlert( @@ -98678,7 +102769,7 @@ export async function secretScanningUpdateAlert( * scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert} + * Learn more at {@link https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert} * Tags: secret-scanning */ export async function secretScanningListLocationsForAlert( @@ -98874,6 +102965,42 @@ export async function securityAdvisoriesUpdateRepositoryAdvisory( '200': { transforms: { date: [[['ref', $date_RepositoryAdvisory]]] } }, }); } +/** + * Request a CVE for a repository security advisory + * If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you + * can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification + * number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You + * may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an + * access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to + * request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * Learn more at {@link https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory} + * Tags: security-advisories + */ +export async function securityAdvisoriesCreateRepositoryAdvisoryCveRequest< + FetcherData, +>( + ctx: r.Context, + params: { + owner: string; + repo: string; + ghsa_id: string; + }, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve', + params, + method: r.HttpMethod.POST, + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** * List stargazers * Lists the people that have starred the repository. @@ -98881,7 +103008,7 @@ export async function securityAdvisoriesUpdateRepositoryAdvisory( * 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: * `application/vnd.github.star+json`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-stargazers} + * Learn more at {@link https://docs.github.com/rest/activity/starring#list-stargazers} * Tags: activity */ export async function activityListStargazersForRepo( @@ -99095,7 +103222,7 @@ export async function reposCreateCommitStatus( /** * List watchers * Lists the people watching the specified repository. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-watchers} + * Learn more at {@link https://docs.github.com/rest/activity/watching#list-watchers} * Tags: activity */ export async function activityListWatchersForRepo( @@ -99120,7 +103247,7 @@ export async function activityListWatchersForRepo( /** * Get a repository subscription * Gets information about whether the authenticated user is subscribed to the repository. - * Learn more at {@link https://docs.github.com/rest/reference/activity#get-a-repository-subscription} + * Learn more at {@link https://docs.github.com/rest/activity/watching#get-a-repository-subscription} * Tags: activity */ export async function activityGetRepoSubscription( @@ -99145,8 +103272,8 @@ export async function activityGetRepoSubscription( * Set a repository subscription * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made * within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's - * subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. - * Learn more at {@link https://docs.github.com/rest/reference/activity#set-a-repository-subscription} + * subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. + * Learn more at {@link https://docs.github.com/rest/activity/watching#set-a-repository-subscription} * Tags: activity */ export async function activitySetRepoSubscription( @@ -99182,8 +103309,8 @@ export async function activitySetRepoSubscription( * Delete 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). - * Learn more at {@link https://docs.github.com/rest/reference/activity#delete-a-repository-subscription} + * manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). + * Learn more at {@link https://docs.github.com/rest/activity/watching#delete-a-repository-subscription} * Tags: activity */ export async function activityDeleteRepoSubscription( @@ -99204,7 +103331,7 @@ export async function activityDeleteRepoSubscription( } /** * List repository tags - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repository-tags} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repository-tags} * Tags: repos */ export async function reposListTags( @@ -99232,7 +103359,7 @@ export async function reposListTags( * * This information is only available to repository * administrators. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-tag-protection-state-of-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository} * Tags: repos */ export async function reposListTagProtection( @@ -99255,7 +103382,7 @@ export async function reposListTagProtection( * Create a tag protection state for a repository * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-tag-protection-state-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository} * Tags: repos */ export async function reposCreateTagProtection( @@ -99285,7 +103412,7 @@ export async function reposCreateTagProtection( * Delete a tag protection state for a repository * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. - * Learn more at {@link https://docs.github.com/rest/reference/repos#delete-tag-protection-state-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository} * Tags: repos */ export async function reposDeleteTagProtection( @@ -99314,7 +103441,7 @@ export async function reposDeleteTagProtection( * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are * temporary and expire after five minutes. - * Learn more at {@link https://docs.github.com/rest/reference/repos#download-a-repository-archive} + * Learn more at {@link https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar} * Tags: repos */ export async function reposDownloadTarballArchive( @@ -99349,7 +103476,7 @@ export async function reposDownloadTarballArchive( * * This endpoint is not compatible with * fine-grained personal access tokens. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repository-teams} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repository-teams} * Tags: repos */ export async function reposListTeams( @@ -99373,7 +103500,7 @@ export async function reposListTeams( } /** * Get all repository topics - * Learn more at {@link https://docs.github.com/rest/reference/repos#get-all-repository-topics} + * Learn more at {@link https://docs.github.com/rest/repos/repos#get-all-repository-topics} * Tags: repos */ export async function reposGetAllTopics( @@ -99397,7 +103524,7 @@ export async function reposGetAllTopics( } /** * Replace all repository topics - * Learn more at {@link https://docs.github.com/rest/reference/repos#replace-all-repository-topics} + * Learn more at {@link https://docs.github.com/rest/repos/repos#replace-all-repository-topics} * Tags: repos */ export async function reposReplaceAllTopics( @@ -99527,7 +103654,10 @@ export async function reposGetViews( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/repos#transfer-a-repository} + * You must use a personal access token (classic) + * or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used + * because they are only granted access to a single account. + * Learn more at {@link https://docs.github.com/rest/repos/repos#transfer-a-repository} * Tags: repos */ export async function reposTransfer( @@ -99568,7 +103698,7 @@ export async function reposTransfer( * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read * access to the repository. For more information, see "[About security alerts for vulnerable * dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - * Learn more at {@link https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository} + * Learn more at {@link https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository} * Tags: repos */ export async function reposCheckVulnerabilityAlerts( @@ -99592,7 +103722,7 @@ export async function reposCheckVulnerabilityAlerts( * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to * the repository. For more information, see "[About security alerts for vulnerable * dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - * Learn more at {@link https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts} + * Learn more at {@link https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts} * Tags: repos */ export async function reposEnableVulnerabilityAlerts( @@ -99618,7 +103748,7 @@ export async function reposEnableVulnerabilityAlerts( * the repository. For more information, * see "[About security alerts for vulnerable * dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - * Learn more at {@link https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts} + * Learn more at {@link https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts} * Tags: repos */ export async function reposDisableVulnerabilityAlerts( @@ -99648,7 +103778,7 @@ export async function reposDisableVulnerabilityAlerts( * **Note**: For private repositories, these links are * temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the * redirect. - * Learn more at {@link https://docs.github.com/rest/reference/repos#download-a-repository-archive} + * Learn more at {@link https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip} * Tags: repos */ export async function reposDownloadZipballArchive( @@ -99673,7 +103803,7 @@ export async function reposDownloadZipballArchive( * 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. If the repository is not public, 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) + * repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) * endpoint and check that the `is_template` key is `true`. * * **OAuth scope requirements** @@ -99685,7 +103815,7 @@ export async function reposDownloadZipballArchive( * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope * to create an internal repository. * * `repo` scope to create a private repository - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template} + * Learn more at {@link https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template} * Tags: repos */ export async function reposCreateUsingTemplate( @@ -99740,7 +103870,7 @@ export async function reposCreateUsingTemplate( * parameter. Use the [Link * header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the * next page of repositories. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-public-repositories} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-public-repositories} * Tags: repos */ export async function reposListPublic( @@ -99765,10 +103895,15 @@ export async function reposListPublic( } /** * List environment secrets - * Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an - * access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to + * Lists all secrets available in an environment without revealing their + * encrypted values. + * + * You must authenticate using an + * access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to * use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#list-environment-secrets} + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#list-environment-secrets} * Tags: actions */ export async function actionsListEnvironmentSecrets( @@ -99801,11 +103936,18 @@ export async function actionsListEnvironmentSecrets( } /** * Get an environment public key - * Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret - * before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the - * repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository + * Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret + * before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * If the + * repository is private you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` repository * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-an-environment-public-key} + * Authenticated users must have collaborator access to a repository to create, update, or + * read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-an-environment-public-key} * Tags: actions */ export async function actionsGetEnvironmentPublicKey( @@ -99826,9 +103968,14 @@ export async function actionsGetEnvironmentPublicKey( } /** * Get an environment secret - * Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with - * the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#get-an-environment-secret} + * Gets a single environment secret without revealing its encrypted value. + * + * You must authenticate using an access token + * with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#get-an-environment-secret} * Tags: actions */ export async function actionsGetEnvironmentSecret( @@ -99854,104 +104001,16 @@ export async function actionsGetEnvironmentSecret( * Create or update an environment secret * Creates or updates an environment secret with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an - * access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to - * use - * this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the - * [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret} + * You must + * authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` + * repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, + * update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret} * Tags: actions */ export async function actionsCreateOrUpdateEnvironmentSecret( @@ -99963,7 +104022,7 @@ export async function actionsCreateOrUpdateEnvironmentSecret( }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ encrypted_value: string; /** @@ -99984,9 +104043,14 @@ export async function actionsCreateOrUpdateEnvironmentSecret( } /** * Delete an environment secret - * Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` - * scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/actions#delete-an-environment-secret} + * Deletes a secret in an environment using the secret name. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Learn more at {@link https://docs.github.com/rest/actions/secrets#delete-an-environment-secret} * Tags: actions */ export async function actionsDeleteEnvironmentSecret( @@ -100008,8 +104072,13 @@ export async function actionsDeleteEnvironmentSecret( } /** * List environment variables - * Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. + * Lists all environment variables. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Authenticated users + * must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#list-environment-variables} * Tags: actions */ @@ -100046,10 +104115,13 @@ export async function actionsListEnvironmentVariables( /** * Create an environment variable * Create an environment variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an * access token with the `repo` scope to use this endpoint. * GitHub Apps must have the `environment:write` repository * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#create-an-environment-variable} * Tags: actions */ @@ -100082,8 +104154,13 @@ export async function actionsCreateEnvironmentVariable( } /** * Get an environment variable - * Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use - * this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Gets a specific variable in an environment. + * + * You must authenticate using an access token with the `repo` scope to use + * this endpoint. + * GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Authenticated + * users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#get-an-environment-variable} * Tags: actions */ @@ -100109,10 +104186,13 @@ export async function actionsGetEnvironmentVariable( /** * Update an environment variable * Updates an environment variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an * access token with the `repo` scope to use this endpoint. * GitHub Apps must have the `environment:write` repository * permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or + * read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#update-an-environment-variable} * Tags: actions */ @@ -100147,9 +104227,12 @@ export async function actionsUpdateEnvironmentVariable( /** * Delete an environment variable * Deletes an environment variable using the variable name. + * * You must authenticate using an access token with the `repo` * scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. + * GitHub Apps must have the `environment:write` repository permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * Learn more at {@link https://docs.github.com/rest/actions/variables#delete-an-environment-variable} * Tags: actions */ @@ -100178,7 +104261,7 @@ export async function actionsDeleteEnvironmentVariable( * 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). + * metadata](https://docs.github.com/rest/search/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 @@ -100190,23 +104273,23 @@ export async function actionsDeleteEnvironmentVariable( * `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the * `jquery/jquery` repository. * - * #### Considerations for code search + * Considerations for code search: * - * Due to the complexity of searching code, there are a - * few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few + * restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will - * be the `master` branch. + * * Only the _default branch_ is considered. In most cases, this will be + * the `master` branch. * * Only files smaller than 384 KB are searchable. - * * You must always include at least one - * search term when searching source code. For example, searching for + * * You must always include at least one search + * term when searching source code. For example, searching for * [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while * [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. * * This endpoint * requires you to authenticate and limits you to 10 requests per minute. - * Learn more at {@link https://docs.github.com/rest/reference/search#search-code} + * Learn more at {@link https://docs.github.com/rest/search/search#search-code} * Tags: search */ export async function searchCode( @@ -100253,14 +104336,14 @@ export async function searchCode( * get text match metadata for the **message** field when you provide the `text-match` media type. For more details about * how to receive highlighted search results, see [Text * match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find * commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would * look something like this: * * `q=repo:octocat/Spoon-Knife+css` - * Learn more at {@link https://docs.github.com/rest/reference/search#search-commits} + * Learn more at {@link https://docs.github.com/rest/search/search#search-commits} * Tags: search */ export async function searchCommits( @@ -100311,10 +104394,10 @@ export async function searchCommits( * get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the * `text-match` media type. For more details about how to receive highlighted * search results, see [Text match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to find the - * oldest unresolved Python bugs on Windows. Your query might look something like + * 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` @@ -100324,14 +104407,13 @@ export async function searchCommits( * Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the * search results. * - * **Note:** For - * [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) - * GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't - * include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get - * results for both issues and pull requests, you must send separate queries for issues and pull requests. For more - * information about the `is` qualifier, see "[Searching only issues or pull + * **Note:** For requests made by GitHub Apps with a user access token, 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)." - * Learn more at {@link https://docs.github.com/rest/reference/search#search-issues-and-pull-requests} + * Learn more at {@link https://docs.github.com/rest/search/search#search-issues-and-pull-requests} * Tags: search */ export async function searchIssuesAndPullRequests( @@ -100388,17 +104470,17 @@ export async function searchIssuesAndPullRequests( * 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). + * metadata](https://docs.github.com/rest/search/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 + * For example, if you want to find labels in + * the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like * this: * * `q=bug+defect+enhancement&repository_id=64778136` * * The labels that best match the query appear first in the * search results. - * Learn more at {@link https://docs.github.com/rest/reference/search#search-labels} + * Learn more at {@link https://docs.github.com/rest/search/search#search-labels} * Tags: search */ export async function searchLabels( @@ -100437,7 +104519,7 @@ export async function searchLabels( * 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). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for * popular Tetris repositories written in assembly code, your query might look like @@ -100449,7 +104531,7 @@ export async function searchLabels( * in the name, the description, or the README. The results are limited to repositories where the primary language is * assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the * search results. - * Learn more at {@link https://docs.github.com/rest/reference/search#search-repositories} + * Learn more at {@link https://docs.github.com/rest/search/search#search-repositories} * Tags: search */ export async function searchRepos( @@ -100496,18 +104578,17 @@ export async function searchRepos( * 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). + * search results, see [Text match metadata](https://docs.github.com/rest/search/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: + * For example, + * if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look + * like this: * * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the - * results to find only topics that are featured. The topics that are the best match for the query appear first in the - * search results. - * Learn more at {@link https://docs.github.com/rest/reference/search#search-topics} + * This query searches for topics with the keyword `ruby` and limits the results to find + * only topics that are featured. The topics that are the best match for the query appear first in the search results. + * Learn more at {@link https://docs.github.com/rest/search/search#search-topics} * Tags: search */ export async function searchTopics( @@ -100551,24 +104632,24 @@ export async function searchTopics( * When searching for users, you can * get text match metadata for the issue **login**, public **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 + * metadata](https://docs.github.com/rest/search/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). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list - * of popular users, you might try this query: + * For example, if you're looking for a list of + * popular users, you might try this query: * * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with - * the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the + * name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This - * endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the - * GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users - * (EMUs), that you are authorized to view. For more information, see "[GraphQL + * This endpoint + * does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL + * API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), + * that you are authorized to view. For more information, see "[GraphQL * Queries](https://docs.github.com/graphql/reference/queries#search)." - * Learn more at {@link https://docs.github.com/rest/reference/search#search-users} + * Learn more at {@link https://docs.github.com/rest/search/search#search-users} * Tags: search */ export async function searchUsers( @@ -100609,10 +104690,10 @@ export async function searchUsers( /** * Get a team (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) + * your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) * endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#get-a-team-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#get-a-team-legacy} * Tags: teams */ export async function teamsGetLegacy( @@ -100635,15 +104716,15 @@ export async function teamsGetLegacy( /** * Update a team (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) - * endpoint. + * your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To + * edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** - * With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested + * teams, the `privacy` for parent teams cannot be `secret`. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#update-a-team-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#update-a-team-legacy} * Tags: teams */ export async function teamsUpdateLegacy( @@ -100702,15 +104783,15 @@ export async function teamsUpdateLegacy( /** * Delete a team (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) - * endpoint. + * your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To + * delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an - * organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization + * owner, deleting a parent team will delete all of its child teams as well. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#delete-a-team-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#delete-a-team-legacy} * Tags: teams */ export async function teamsDeleteLegacy( @@ -100731,13 +104812,13 @@ export async function teamsDeleteLegacy( /** * List discussions (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) + * your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) * endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-discussions-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#list-discussions-legacy} * Tags: teams */ export async function teamsListDiscussionsLegacy( @@ -100767,10 +104848,10 @@ export async function teamsListDiscussionsLegacy( * Create a discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`Create a - * discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. + * discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post - * on a team's page. OAuth access tokens require the `write:discussion` + * Creates a new discussion + * post on a team's page. OAuth access tokens require the `write:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * This endpoint triggers @@ -100781,7 +104862,7 @@ export async function teamsListDiscussionsLegacy( * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#create-a-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy} * Tags: teams */ export async function teamsCreateDiscussionLegacy( @@ -100819,13 +104900,13 @@ export async function teamsCreateDiscussionLegacy( /** * Get a discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) + * your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) * endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-a-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy} * Tags: teams */ export async function teamsGetDiscussionLegacy( @@ -100850,13 +104931,13 @@ export async function teamsGetDiscussionLegacy( * Update a discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Update a - * discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. + * discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text * of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#update-a-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy} * Tags: teams */ export async function teamsUpdateDiscussionLegacy( @@ -100892,13 +104973,13 @@ export async function teamsUpdateDiscussionLegacy( * Delete a discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`Delete a - * discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. + * discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a * team's page. OAuth access tokens require the `write:discussion` * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy} * Tags: teams */ export async function teamsDeleteDiscussionLegacy( @@ -100921,13 +105002,13 @@ export async function teamsDeleteDiscussionLegacy( * List discussion comments (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [List discussion - * comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. + * comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team - * discussion. OAuth access tokens require the `read:discussion` + * 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/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy} * Tags: teams */ export async function teamsListDiscussionCommentsLegacy( @@ -100958,10 +105039,10 @@ export async function teamsListDiscussionCommentsLegacy( * Create a discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Create a discussion - * comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. + * comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a - * team discussion. OAuth access tokens require the `write:discussion` + * 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 @@ -100972,7 +105053,7 @@ export async function teamsListDiscussionCommentsLegacy( * limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for * details. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy} * Tags: teams */ export async function teamsCreateDiscussionCommentLegacy( @@ -101004,13 +105085,13 @@ export async function teamsCreateDiscussionCommentLegacy( * Get a discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Get a discussion - * comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. + * comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a - * team discussion. OAuth access tokens require the `read:discussion` + * 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/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy} * Tags: teams */ export async function teamsGetDiscussionCommentLegacy( @@ -101036,13 +105117,13 @@ export async function teamsGetDiscussionCommentLegacy( * Update a discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Update a discussion - * comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. + * comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a - * discussion comment. OAuth access tokens require the `write:discussion` + * 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/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy} * Tags: teams */ export async function teamsUpdateDiscussionCommentLegacy( @@ -101075,13 +105156,13 @@ export async function teamsUpdateDiscussionCommentLegacy( * Delete a discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Delete a discussion - * comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. + * comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a - * team discussion. OAuth access tokens require the `write:discussion` + * 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/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy} * Tags: teams */ export async function teamsDeleteDiscussionCommentLegacy( @@ -101105,14 +105186,14 @@ export async function teamsDeleteDiscussionCommentLegacy( * List reactions for a team discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`List reactions for a team discussion - * comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List - * the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth - * access tokens require the `read:discussion` - * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * the reactions to a [team discussion + * comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require + * the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy} * Tags: reactions */ export async function reactionsListForTeamDiscussionCommentLegacy( @@ -101150,15 +105231,15 @@ export async function reactionsListForTeamDiscussionCommentLegacy( * Create reaction for a team discussion comment (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new "[Create reaction for a team discussion - * comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" + * comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" * endpoint. * * Create a reaction to a [team discussion - * comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the - * `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A + * comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require + * the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A * response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy} * Tags: reactions */ export async function reactionsCreateForTeamDiscussionCommentLegacy< @@ -101172,7 +105253,7 @@ export async function reactionsCreateForTeamDiscussionCommentLegacy< }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. */ content: | '+1' @@ -101201,13 +105282,14 @@ export async function reactionsCreateForTeamDiscussionCommentLegacy< * List reactions for a team discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`List reactions for a team - * discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. + * discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the - * reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require - * the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens + * require the `read:discussion` + * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy} * Tags: reactions */ export async function reactionsListForTeamDiscussionLegacy( @@ -101244,14 +105326,15 @@ export async function reactionsListForTeamDiscussionLegacy( * Create reaction for a team discussion (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`Create reaction for a team - * discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. + * discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a - * reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require - * the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A - * response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens + * require the `write:discussion` + * [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP + * `200` status means that you already added the reaction type to this team discussion. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy} + * Learn more at {@link https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy} * Tags: reactions */ export async function reactionsCreateForTeamDiscussionLegacy( @@ -101262,7 +105345,7 @@ export async function reactionsCreateForTeamDiscussionLegacy( }, body: { /** - * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. */ content: | '+1' @@ -101291,14 +105374,14 @@ export async function reactionsCreateForTeamDiscussionLegacy( * List pending team invitations (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [`List pending team - * invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. + * invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash * contains a `role` field which refers to the Organization Invitation role and will be one of the following values: * `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, * the `login` field in the return hash will be `null`. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy} * Tags: teams */ export async function teamsListPendingInvitationsLegacy( @@ -101322,12 +105405,12 @@ export async function teamsListPendingInvitationsLegacy( /** * List team members (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) + * your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) * endpoint. * * Team members will include the members of child teams. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-team-members-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#list-team-members-legacy} * Tags: teams */ export async function teamsListMembersLegacy( @@ -101354,12 +105437,12 @@ export async function teamsListMembersLegacy( * The "Get team member" endpoint (described below) is deprecated. * * We recommend using the [Get team membership for a - * user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to - * get both active and pending memberships. + * user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get + * both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-team-member-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#get-team-member-legacy} * Tags: teams */ export async function teamsGetMemberLegacy( @@ -101383,7 +105466,7 @@ export async function teamsGetMemberLegacy( * The "Add team member" endpoint (described below) is deprecated. * * We recommend using the [Add or update team membership - * for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It + * for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It * allows you to invite new organization members to your teams. * * Team synchronization is available for organizations using @@ -101406,7 +105489,7 @@ export async function teamsGetMemberLegacy( * 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)." * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#add-team-member-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#add-team-member-legacy} * Tags: teams */ export async function teamsAddMemberLegacy( @@ -101430,7 +105513,7 @@ export async function teamsAddMemberLegacy( * The "Remove team member" endpoint (described below) is deprecated. * * We recommend using the [Remove team membership for a - * user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to + * user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to * remove both active and pending memberships. * * Team synchronization is available for organizations using GitHub Enterprise @@ -101449,7 +105532,7 @@ export async function teamsAddMemberLegacy( * between your identity provider and * GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#remove-team-member-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#remove-team-member-legacy} * Tags: teams */ export async function teamsRemoveMemberLegacy( @@ -101472,7 +105555,7 @@ export async function teamsRemoveMemberLegacy( * Get team membership for a user (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Get team membership for a - * user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. + * user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include * the members of child teams. @@ -101485,9 +105568,9 @@ export async function teamsRemoveMemberLegacy( * * The `role` for * organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a - * team](https://docs.github.com/rest/reference/teams#create-a-team). + * team](https://docs.github.com/rest/teams/teams#create-a-team). * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy} * Tags: teams */ export async function teamsGetMembershipForUserLegacy( @@ -101510,7 +105593,7 @@ export async function teamsGetMembershipForUserLegacy( * Add or update team membership for a user (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Add or update team membership for a - * user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. + * user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team * synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's @@ -101538,7 +105621,7 @@ export async function teamsGetMembershipForUserLegacy( * member of the team, this endpoint will update the role of the team member's role. To update the membership of a team * member, the authenticated user must be an organization owner or a team maintainer. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy} * Tags: teams */ export async function teamsAddOrUpdateMembershipForUserLegacy( @@ -101569,7 +105652,7 @@ export async function teamsAddOrUpdateMembershipForUserLegacy( * Remove team membership for a user (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Remove team membership for a - * user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. + * user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is * available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's @@ -101587,7 +105670,7 @@ export async function teamsAddOrUpdateMembershipForUserLegacy( * 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/)." * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy} * Tags: teams */ export async function teamsRemoveMembershipForUserLegacy( @@ -101609,13 +105692,12 @@ export async function teamsRemoveMembershipForUserLegacy( /** * List team projects (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [`List team - * projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. + * your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) + * endpoint. * - * Lists the organization projects - * for a team. + * Lists the organization projects for a team. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#list-team-projects-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-team-projects-legacy} * Tags: teams */ export async function teamsListProjectsLegacy( @@ -101640,13 +105722,13 @@ export async function teamsListProjectsLegacy( * Check team permissions for a project (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Check team permissions for a - * project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. + * project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a - * team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited - * from a parent team. + * Checks whether a team + * has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a + * parent team. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-project-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy} * Tags: teams */ export async function teamsCheckPermissionsForProjectLegacy( @@ -101669,14 +105751,14 @@ export async function teamsCheckPermissionsForProjectLegacy( * Add or update team project permissions (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Add or update team project - * permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. + * permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an * organization project to a team. To add a project to a team or update the team's permission on a project, the * authenticated user must have `admin` permissions for the project. The project and team must be part of the same * organization. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#add-or-update-team-project-permissions-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy} * Tags: teams */ export async function teamsAddOrUpdateProjectPermissionsLegacy( @@ -101706,15 +105788,14 @@ export async function teamsAddOrUpdateProjectPermissionsLegacy( * Remove a project from a team (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Remove a project from a - * team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. + * team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization - * project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a - * project from a team as an organization member, the authenticated user must have `read` access to both the team and - * project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does - * not delete it. + * Removes an organization project + * from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a + * team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` + * access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#remove-a-project-from-a-team-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy} * Tags: teams */ export async function teamsRemoveProjectLegacy( @@ -101737,9 +105818,9 @@ export async function teamsRemoveProjectLegacy( * List team repositories (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [List team - * repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. + * repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-team-repositories-legacy} * Tags: teams */ export async function teamsListReposLegacy( @@ -101771,13 +105852,13 @@ export async function teamsListReposLegacy( * **Deprecation Notice:** This endpoint * route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new * [Check team permissions for a - * repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can - * also get information about the specified repository, including what permissions the team grants on it, by passing the + * You can also + * get information about the specified repository, including what permissions the team grants on it, by passing the * following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy} * Tags: teams */ export async function teamsCheckPermissionsForRepoLegacy( @@ -101803,10 +105884,10 @@ export async function teamsCheckPermissionsForRepoLegacy( * Add or update team repository permissions (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new "[Add or update team repository - * permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * To add - * a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to + * 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. @@ -101815,7 +105896,7 @@ export async function teamsCheckPermissionsForRepoLegacy( * 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)." * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy} * Tags: teams */ export async function teamsAddOrUpdateRepoPermissionsLegacy( @@ -101846,14 +105927,14 @@ export async function teamsAddOrUpdateRepoPermissionsLegacy( * Remove a repository from a team (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating * your existing code to use the new [Remove a repository from a - * team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user - * is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository - * from a team as an organization member, the authenticated user must have admin access to the repository and must be able - * to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is + * an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from + * a team as an organization member, the authenticated user must have admin access to the repository and must be able to + * see the team. NOTE: This does not delete the repository, it just removes it from the team. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy} * Tags: teams */ export async function teamsRemoveRepoLegacy( @@ -101876,10 +105957,10 @@ export async function teamsRemoveRepoLegacy( /** * List child teams (Legacy) * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating - * your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) + * your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) * endpoint. * @deprecated - * Learn more at {@link https://docs.github.com/rest/reference/teams/#list-child-teams-legacy} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-child-teams-legacy} * Tags: teams */ export async function teamsListChildLegacy( @@ -101907,7 +105988,7 @@ export async function teamsListChildLegacy( * * If the authenticated user is authenticated through OAuth without the `user` scope, then * the response lists only public profile information. - * Learn more at {@link https://docs.github.com/rest/reference/users#get-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/users#get-the-authenticated-user} * Tags: users */ export async function usersGetAuthenticated( @@ -101941,7 +106022,7 @@ export async function usersGetAuthenticated( * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your * profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via * the API. - * Learn more at {@link https://docs.github.com/rest/reference/users/#update-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/users#update-the-authenticated-user} * Tags: users */ export async function usersUpdateAuthenticated( @@ -102003,7 +106084,7 @@ export async function usersUpdateAuthenticated( /** * List users blocked by the authenticated user * List the users you've blocked on your personal account. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user} * Tags: users */ export async function usersListBlockedByAuthenticatedUser( @@ -102027,7 +106108,7 @@ export async function usersListBlockedByAuthenticatedUser( * Check if a user is blocked by the authenticated user * Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by * the authenticated user, or if the given user account has been identified as spam by GitHub. - * Learn more at {@link https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user} * Tags: users */ export async function usersCheckBlocked( @@ -102048,7 +106129,7 @@ export async function usersCheckBlocked( /** * Block a user * Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. - * Learn more at {@link https://docs.github.com/rest/reference/users#block-a-user} + * Learn more at {@link https://docs.github.com/rest/users/blocking#block-a-user} * Tags: users */ export async function usersBlock( @@ -102069,7 +106150,7 @@ export async function usersBlock( /** * Unblock a user * Unblocks the given user and returns a 204. - * Learn more at {@link https://docs.github.com/rest/reference/users#unblock-a-user} + * Learn more at {@link https://docs.github.com/rest/users/blocking#unblock-a-user} * Tags: users */ export async function usersUnblock( @@ -102095,7 +106176,7 @@ export async function usersUnblock( * use this endpoint. * * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesListForAuthenticatedUser( @@ -102139,7 +106220,7 @@ export async function codespacesListForAuthenticatedUser( * endpoint. * * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesCreateForAuthenticatedUser( @@ -102260,7 +106341,7 @@ export async function codespacesCreateForAuthenticatedUser( * * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use * this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesListSecretsForAuthenticatedUser( @@ -102301,7 +106382,7 @@ export async function codespacesListSecretsForAuthenticatedUser( * * GitHub Apps must have read access to the * `codespaces_user_secrets` user permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesGetPublicKeyForAuthenticatedUser( @@ -102327,7 +106408,7 @@ export async function codespacesGetPublicKeyForAuthenticatedUser( * * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesGetSecretForAuthenticatedUser( @@ -102351,108 +106432,16 @@ export async function codespacesGetSecretForAuthenticatedUser( * Create or update a secret for the authenticated user * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret * using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). - * - * You must authenticate using an access - * token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to - * use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and - * `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. - * - * **Example encrypting a - * secret using Node.js** + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting + * secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Encrypt your secret using the - * [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = - * require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const - * key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then - * proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = - * sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the - * secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to - * Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using - * [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import - * b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a - * Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), - * encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = - * sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting - * a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) - * package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = - * Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = - * Sodium.SealedPublicKeyBox.Create(secretValue, - * publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using - * Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require - * "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = - * RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = - * box.encrypt("my_secret") + * You must + * authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must + * also have Codespaces access to use this endpoint. * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user} + * GitHub Apps must have write access to the `codespaces_user_secrets` + * user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesCreateOrUpdateSecretForAuthenticatedUser< @@ -102464,7 +106453,7 @@ export async function codespacesCreateOrUpdateSecretForAuthenticatedUser< }, body: { /** - * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ encrypted_value?: string; /** @@ -102472,7 +106461,7 @@ export async function codespacesCreateOrUpdateSecretForAuthenticatedUser< */ key_id: string; /** - * An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. + * An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ selected_repository_ids?: (number | string)[]; }, @@ -102497,7 +106486,7 @@ export async function codespacesCreateOrUpdateSecretForAuthenticatedUser< * * GitHub Apps must * have write access to the `codespaces_user_secrets` user permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesDeleteSecretForAuthenticatedUser( @@ -102525,7 +106514,7 @@ export async function codespacesDeleteSecretForAuthenticatedUser( * * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write * access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret} * Tags: codespaces */ export async function codespacesListRepositoriesForSecretForAuthenticatedUser< @@ -102570,7 +106559,7 @@ export async function codespacesListRepositoriesForSecretForAuthenticatedUser< * * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the * `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret} * Tags: codespaces */ export async function codespacesSetRepositoriesForSecretForAuthenticatedUser< @@ -102582,7 +106571,7 @@ export async function codespacesSetRepositoriesForSecretForAuthenticatedUser< }, body: { /** - * An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. + * An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ selected_repository_ids: number[]; }, @@ -102605,7 +106594,7 @@ export async function codespacesSetRepositoriesForSecretForAuthenticatedUser< * this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to * the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret} * Tags: codespaces */ export async function codespacesAddRepositoryForSecretForAuthenticatedUser< @@ -102633,7 +106622,7 @@ export async function codespacesAddRepositoryForSecretForAuthenticatedUser< * token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use * this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret} + * Learn more at {@link https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret} * Tags: codespaces */ export async function codespacesRemoveRepositoryForSecretForAuthenticatedUser< @@ -102662,7 +106651,7 @@ export async function codespacesRemoveRepositoryForSecretForAuthenticatedUser< * use this endpoint. * * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesGetForAuthenticatedUser( @@ -102694,7 +106683,7 @@ export async function codespacesGetForAuthenticatedUser( * * GitHub Apps must * have write access to the `codespaces` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesUpdateForAuthenticatedUser( @@ -102737,7 +106726,7 @@ export async function codespacesUpdateForAuthenticatedUser( * endpoint. * * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesDeleteForAuthenticatedUser( @@ -102829,7 +106818,7 @@ export async function codespacesGetExportDetailsForAuthenticatedUser< * * GitHub Apps must have read access to the `codespaces_metadata` repository * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace} + * Learn more at {@link https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace} * Tags: codespaces */ export async function codespacesCodespaceMachinesForAuthenticatedUser< @@ -102870,7 +106859,7 @@ export async function codespacesCodespaceMachinesForAuthenticatedUser< * * GitHub Apps must have write access to the `codespaces` repository * permission to use this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace} * Tags: codespaces */ export async function codespacesPublishForAuthenticatedUser( @@ -102912,7 +106901,7 @@ export async function codespacesPublishForAuthenticatedUser( * * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesStartForAuthenticatedUser( @@ -102941,7 +106930,7 @@ export async function codespacesStartForAuthenticatedUser( * * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user} * Tags: codespaces */ export async function codespacesStopForAuthenticatedUser( @@ -102967,7 +106956,7 @@ export async function codespacesStopForAuthenticatedUser( * during a Docker migration. * To use this endpoint, you must authenticate using an access token with the `read:packages` * scope. - * Learn more at {@link https://docs.github.com/rest/packages#list-docker-migration-conflicting-packages-for-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user} * Tags: packages */ export async function packagesListDockerMigrationConflictingPackagesForAuthenticatedUser< @@ -102990,7 +106979,7 @@ export async function packagesListDockerMigrationConflictingPackagesForAuthentic /** * Set primary email visibility for the authenticated user * Sets the visibility for your primary email addresses. - * Learn more at {@link https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user} * Tags: users */ export async function usersSetPrimaryEmailVisibilityForAuthenticatedUser< @@ -103019,7 +107008,7 @@ export async function usersSetPrimaryEmailVisibilityForAuthenticatedUser< * List email addresses for the authenticated user * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with * the `user:email` scope. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user} * Tags: users */ export async function usersListEmailsForAuthenticatedUser( @@ -103042,7 +107031,7 @@ export async function usersListEmailsForAuthenticatedUser( /** * Add an email address for the authenticated user * This endpoint is accessible with the `user` scope. - * Learn more at {@link https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user} * Tags: users */ export async function usersAddEmailForAuthenticatedUser( @@ -103072,7 +107061,7 @@ export async function usersAddEmailForAuthenticatedUser( /** * Delete an email address for the authenticated user * This endpoint is accessible with the `user` scope. - * Learn more at {@link https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user} * Tags: users */ export async function usersDeleteEmailForAuthenticatedUser( @@ -103101,7 +107090,7 @@ export async function usersDeleteEmailForAuthenticatedUser( /** * List followers of the authenticated user * Lists the people following the authenticated user. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user} * Tags: users */ export async function usersListFollowersForAuthenticatedUser( @@ -103124,7 +107113,7 @@ export async function usersListFollowersForAuthenticatedUser( /** * List the people the authenticated user follows * Lists the people who the authenticated user follows. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows} + * Learn more at {@link https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows} * Tags: users */ export async function usersListFollowedByAuthenticatedUser( @@ -103146,7 +107135,7 @@ export async function usersListFollowedByAuthenticatedUser( } /** * Check if a person is followed by the authenticated user - * Learn more at {@link https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user} * Tags: users */ export async function usersCheckPersonIsFollowedByAuthenticated( @@ -103171,7 +107160,7 @@ export async function usersCheckPersonIsFollowedByAuthenticated( * * Following a user requires * the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. - * Learn more at {@link https://docs.github.com/rest/reference/users#follow-a-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#follow-a-user} * Tags: users */ export async function usersFollow( @@ -103193,7 +107182,7 @@ export async function usersFollow( * Unfollow a user * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` * scope. - * Learn more at {@link https://docs.github.com/rest/reference/users#unfollow-a-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#unfollow-a-user} * Tags: users */ export async function usersUnfollow( @@ -103215,7 +107204,7 @@ export async function usersUnfollow( * List GPG keys for the authenticated user * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user} * Tags: users */ export async function usersListGpgKeysForAuthenticatedUser( @@ -103242,7 +107231,7 @@ export async function usersListGpgKeysForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user} * Tags: users */ export async function usersCreateGpgKeyForAuthenticatedUser( @@ -103275,7 +107264,7 @@ export async function usersCreateGpgKeyForAuthenticatedUser( * Get a GPG key for the authenticated user * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user} * Tags: users */ export async function usersGetGpgKeyForAuthenticatedUser( @@ -103300,7 +107289,7 @@ export async function usersGetGpgKeyForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user} * Tags: users */ export async function usersDeleteGpgKeyForAuthenticatedUser( @@ -103323,8 +107312,8 @@ export async function usersDeleteGpgKeyForAuthenticatedUser( * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or * `:admin`) to access. * - * You must use a [user-to-server OAuth access - * token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), + * You must use a [user access + * token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), * created for a user who has authorized your GitHub App, to access this endpoint. * * The authenticated user has explicit @@ -103333,7 +107322,7 @@ export async function usersDeleteGpgKeyForAuthenticatedUser( * * You can find the permissions for the installation under the `permissions` * key. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token} + * Learn more at {@link https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token} * Tags: apps */ export async function appsListInstallationsForAuthenticatedUser( @@ -103375,14 +107364,14 @@ export async function appsListInstallationsForAuthenticatedUser( * The authenticated user has explicit permission to access repositories they own, repositories where they * are a collaborator, and repositories that they can access through an organization membership. * - * You must use a - * [user-to-server OAuth access - * token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), + * You must use a [user + * access + * token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token} + * Learn more at {@link https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token} * Tags: apps */ export async function appsListInstallationReposForAuthenticatedUser< @@ -103429,7 +107418,7 @@ export async function appsListInstallationReposForAuthenticatedUser< * line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic * Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this * endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation} + * Learn more at {@link https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation} * Tags: apps */ export async function appsAddRepoToInstallationForAuthenticatedUser< @@ -103459,7 +107448,7 @@ export async function appsAddRepoToInstallationForAuthenticatedUser< * create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) * or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to * access this endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation} + * Learn more at {@link https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation} * Tags: apps */ export async function appsRemoveRepoFromInstallationForAuthenticatedUser< @@ -103483,7 +107472,7 @@ export async function appsRemoveRepoFromInstallationForAuthenticatedUser< /** * Get interaction restrictions for your public repositories * Shows which type of GitHub user can interact with your public repositories and when the restriction expires. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories} + * Learn more at {@link https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories} * Tags: interactions */ export async function interactionsGetRestrictionsForAuthenticatedUser< @@ -103512,7 +107501,7 @@ export async function interactionsGetRestrictionsForAuthenticatedUser< * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction * limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the * user. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories} + * Learn more at {@link https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories} * Tags: interactions */ export async function interactionsSetRestrictionsForAuthenticatedUser< @@ -103539,7 +107528,7 @@ export async function interactionsSetRestrictionsForAuthenticatedUser< /** * Remove interaction restrictions from your public repositories * Removes any interaction restrictions from your public repositories. - * Learn more at {@link https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories} + * Learn more at {@link https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories} * Tags: interactions */ export async function interactionsRemoveRestrictionsForAuthenticatedUser< @@ -103568,8 +107557,8 @@ export async function interactionsRemoveRestrictionsForAuthenticatedUser< * the `pull_request` key. Be aware * that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, - * use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. - * Learn more at {@link https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user} + * use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * Learn more at {@link https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user} * Tags: issues */ export async function issuesListForAuthenticatedUser( @@ -103617,7 +107606,7 @@ export async function issuesListForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user} * Tags: users */ export async function usersListPublicSshKeysForAuthenticatedUser( @@ -103644,7 +107633,7 @@ export async function usersListPublicSshKeysForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user} * Tags: users */ export async function usersCreatePublicSshKeyForAuthenticatedUser( @@ -103679,7 +107668,7 @@ export async function usersCreatePublicSshKeyForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user} * Tags: users */ export async function usersGetPublicSshKeyForAuthenticatedUser( @@ -103704,7 +107693,7 @@ export async function usersGetPublicSshKeyForAuthenticatedUser( * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user} * Tags: users */ export async function usersDeletePublicSshKeyForAuthenticatedUser( @@ -103724,11 +107713,11 @@ export async function usersDeletePublicSshKeyForAuthenticatedUser( } /** * List subscriptions for the authenticated user - * 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/). - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user} + * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access + * token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), + * 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user} * Tags: apps */ export async function appsListSubscriptionsForAuthenticatedUser( @@ -103756,11 +107745,11 @@ export async function appsListSubscriptionsForAuthenticatedUser( } /** * List subscriptions for the authenticated user (stubbed) - * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access - * token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), - * created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an - * [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). - * Learn more at {@link https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed} + * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access + * token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), + * 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * Learn more at {@link https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed} * Tags: apps */ export async function appsListSubscriptionsForAuthenticatedUserStubbed< @@ -103791,7 +107780,7 @@ export async function appsListSubscriptionsForAuthenticatedUserStubbed< /** * List organization memberships for the authenticated user * Lists all of the authenticated user's organization memberships. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user} * Tags: orgs */ export async function orgsListMembershipsForAuthenticatedUser( @@ -103817,7 +107806,7 @@ export async function orgsListMembershipsForAuthenticatedUser( * If the authenticated user is an active or pending member of the organization, this endpoint will return the user's * membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will * return a `403` if the request is made by a GitHub App that is blocked by the organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user} * Tags: orgs */ export async function orgsGetMembershipForAuthenticatedUser( @@ -103839,7 +107828,7 @@ export async function orgsGetMembershipForAuthenticatedUser( * Update an organization membership for the authenticated user * Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the * organization. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user} * Tags: orgs */ export async function orgsUpdateMembershipForAuthenticatedUser( @@ -104128,7 +108117,7 @@ export async function migrationsListReposForAuthenticatedUser( * authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize * your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. * OAuth requests with insufficient scope receive a `403 Forbidden` response. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user} * Tags: orgs */ export async function orgsListForAuthenticatedUser( @@ -104157,7 +108146,7 @@ export async function orgsListForAuthenticatedUser( * only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub * Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace} * Tags: packages */ export async function packagesListPackagesForAuthenticatedUser( @@ -104196,7 +108185,7 @@ export async function packagesListPackagesForAuthenticatedUser( * only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub * Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user} * Tags: packages */ export async function packagesGetPackageForAuthenticatedUser( @@ -104235,7 +108224,7 @@ export async function packagesGetPackageForAuthenticatedUser( * `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About * permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user} * Tags: packages */ export async function packagesDeletePackageForAuthenticatedUser( @@ -104276,7 +108265,7 @@ export async function packagesDeletePackageForAuthenticatedUser( * repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries * that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user} * Tags: packages */ export async function packagesRestorePackageForAuthenticatedUser( @@ -104312,7 +108301,7 @@ export async function packagesRestorePackageForAuthenticatedUser( * supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages * registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user} * Tags: packages */ export async function packagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUser< @@ -104356,7 +108345,7 @@ export async function packagesGetAllPackageVersionsForPackageOwnedByAuthenticate * registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list * of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user} * Tags: packages */ export async function packagesGetPackageVersionForAuthenticatedUser< @@ -104399,7 +108388,7 @@ export async function packagesGetPackageVersionForAuthenticatedUser< * scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About * permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user} * Tags: packages */ export async function packagesDeletePackageVersionForAuthenticatedUser< @@ -104444,7 +108433,7 @@ export async function packagesDeletePackageVersionForAuthenticatedUser< * supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages * registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user} * Tags: packages */ export async function packagesRestorePackageVersionForAuthenticatedUser< @@ -104476,7 +108465,7 @@ export async function packagesRestorePackageVersionForAuthenticatedUser< * Create a user project * Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do * not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * Learn more at {@link https://docs.github.com/rest/reference/projects#create-a-user-project} + * Learn more at {@link https://docs.github.com/rest/projects/projects#create-a-user-project} * Tags: projects */ export async function projectsCreateForAuthenticatedUser( @@ -104510,10 +108499,9 @@ export async function projectsCreateForAuthenticatedUser( /** * List public email addresses for the authenticated user * 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. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user} + * authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. This endpoint is accessible with the `user:email` scope. + * Learn more at {@link https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user} * Tags: users */ export async function usersListPublicEmailsForAuthenticatedUser( @@ -104540,7 +108528,7 @@ export async function usersListPublicEmailsForAuthenticatedUser( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user} * Tags: repos */ export async function reposListForAuthenticatedUser( @@ -104592,7 +108580,7 @@ export async function reposListForAuthenticatedUser( * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope * to create an internal repository. * * `repo` scope to create a private repository. - * Learn more at {@link https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user} * Tags: repos */ export async function reposCreateForAuthenticatedUser( @@ -104831,7 +108819,7 @@ export async function usersListSocialAccountsForAuthenticatedUser( /** * Add social accounts for the authenticated user * Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. - * Learn more at {@link https://docs.github.com/rest/users/social-accounts#add-social-account-for-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user} * Tags: users */ export async function usersAddSocialAccountForAuthenticatedUser( @@ -104859,7 +108847,7 @@ export async function usersAddSocialAccountForAuthenticatedUser( * Delete social accounts for the authenticated user * Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` * scope. - * Learn more at {@link https://docs.github.com/rest/users/social-accounts#delete-social-account-for-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user} * Tags: users */ export async function usersDeleteSocialAccountForAuthenticatedUser( @@ -104889,7 +108877,7 @@ export async function usersDeleteSocialAccountForAuthenticatedUser( * or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see * "[Understanding scopes for OAuth * apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." - * Learn more at {@link https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user} * Tags: users */ export async function usersListSshSigningKeysForAuthenticatedUser( @@ -104917,7 +108905,7 @@ export async function usersListSshSigningKeysForAuthenticatedUser( * or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see * "[Understanding scopes for OAuth * apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." - * Learn more at {@link https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user} * Tags: users */ export async function usersCreateSshSigningKeyForAuthenticatedUser( @@ -104952,7 +108940,7 @@ export async function usersCreateSshSigningKeyForAuthenticatedUser( * Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate * with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth * apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." - * Learn more at {@link https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user} * Tags: users */ export async function usersGetSshSigningKeyForAuthenticatedUser( @@ -104978,7 +108966,7 @@ export async function usersGetSshSigningKeyForAuthenticatedUser( * Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, * see "[Understanding scopes for OAuth * apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." - * Learn more at {@link https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user} * Tags: users */ export async function usersDeleteSshSigningKeyForAuthenticatedUser( @@ -105003,7 +108991,7 @@ export async function usersDeleteSshSigningKeyForAuthenticatedUser( * 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: * `application/vnd.github.star+json`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user} * Tags: activity */ export async function activityListReposStarredByAuthenticatedUser( @@ -105030,7 +109018,7 @@ export async function activityListReposStarredByAuthenticatedUser( /** * Check if a repository is starred by the authenticated user * Whether the authenticated user has starred the repository. - * Learn more at {@link https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user} * Tags: activity */ export async function activityCheckRepoIsStarredByAuthenticatedUser< @@ -105055,7 +109043,7 @@ export async function activityCheckRepoIsStarredByAuthenticatedUser< * Star a repository for the authenticated user * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see * "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." - * Learn more at {@link https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user} * Tags: activity */ export async function activityStarRepoForAuthenticatedUser( @@ -105077,7 +109065,7 @@ export async function activityStarRepoForAuthenticatedUser( /** * Unstar a repository for the authenticated user * Unstar a repository that the authenticated user has previously starred. - * Learn more at {@link https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user} * Tags: activity */ export async function activityUnstarRepoForAuthenticatedUser( @@ -105099,7 +109087,7 @@ export async function activityUnstarRepoForAuthenticatedUser( /** * List repositories watched by the authenticated user * Lists repositories the authenticated user is watching. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user} * Tags: activity */ export async function activityListWatchedReposForAuthenticatedUser( @@ -105133,7 +109121,7 @@ export async function activityListWatchedReposForAuthenticatedUser( * organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), * and have at least read-only member organization permissions. The response payload only contains the teams from a single * organization when using a fine-grained personal access token. - * Learn more at {@link https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user} * Tags: teams */ export async function teamsListForAuthenticatedUser( @@ -105163,7 +109151,7 @@ export async function teamsListForAuthenticatedUser( * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link * header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the * next page of users. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-users} + * Learn more at {@link https://docs.github.com/rest/users/users#list-users} * Tags: users */ export async function usersList( @@ -105202,8 +109190,8 @@ export async function usersList( * * 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)". - * Learn more at {@link https://docs.github.com/rest/reference/users#get-a-user} + * information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * Learn more at {@link https://docs.github.com/rest/users/users#get-a-user} * Tags: users */ export async function usersGetByUsername( @@ -105240,7 +109228,7 @@ export async function usersGetByUsername( * a conflict during Docker migration. * To use this endpoint, you must authenticate using an access token with the * `read:packages` scope. - * Learn more at {@link https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user} * Tags: packages */ export async function packagesListDockerMigrationConflictingPackagesForUser< @@ -105265,7 +109253,7 @@ export async function packagesListDockerMigrationConflictingPackagesForUser< /** * List events for the authenticated user * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user} * Tags: activity */ export async function activityListEventsForAuthenticatedUser( @@ -105291,7 +109279,7 @@ export async function activityListEventsForAuthenticatedUser( /** * List organization events for the authenticated user * This is the user's organization dashboard. You must be authenticated as the user to view this. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user} * Tags: activity */ export async function activityListOrgEventsForAuthenticatedUser( @@ -105317,7 +109305,7 @@ export async function activityListOrgEventsForAuthenticatedUser( } /** * List public events for a user - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-public-events-for-a-user} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-public-events-for-a-user} * Tags: activity */ export async function activityListPublicEventsForUser( @@ -105343,7 +109331,7 @@ export async function activityListPublicEventsForUser( /** * List followers of a user * Lists the people following the specified user. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-followers-of-a-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#list-followers-of-a-user} * Tags: users */ export async function usersListFollowersForUser( @@ -105367,7 +109355,7 @@ export async function usersListFollowersForUser( /** * List the people a user follows * Lists the people who the specified user follows. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-the-people-a-user-follows} + * Learn more at {@link https://docs.github.com/rest/users/followers#list-the-people-a-user-follows} * Tags: users */ export async function usersListFollowingForUser( @@ -105390,7 +109378,7 @@ export async function usersListFollowingForUser( } /** * Check if a user follows another user - * Learn more at {@link https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user} + * Learn more at {@link https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user} * Tags: users */ export async function usersCheckFollowingForUser( @@ -105412,7 +109400,7 @@ export async function usersCheckFollowingForUser( /** * List gists for a user * Lists public gists for the specified user: - * Learn more at {@link https://docs.github.com/rest/reference/gists#list-gists-for-a-user} + * Learn more at {@link https://docs.github.com/rest/gists/gists#list-gists-for-a-user} * Tags: gists */ export async function gistsListForUser( @@ -105439,7 +109427,7 @@ export async function gistsListForUser( /** * List GPG keys for a user * Lists the GPG keys for a user. This information is accessible by anyone. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user} + * Learn more at {@link https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user} * Tags: users */ export async function usersListGpgKeysForUser( @@ -105476,7 +109464,7 @@ export async function usersListGpgKeysForUser( * curl -u username:token * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` - * Learn more at {@link https://docs.github.com/rest/reference/users#get-contextual-information-for-a-user} + * Learn more at {@link https://docs.github.com/rest/users/users#get-contextual-information-for-a-user} * Tags: users */ export async function usersGetContextForUser( @@ -105504,7 +109492,7 @@ export async function usersGetContextForUser( * 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. - * Learn more at {@link https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app} + * Learn more at {@link https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app} * Tags: apps */ export async function appsGetUserInstallation( @@ -105527,7 +109515,7 @@ export async function appsGetUserInstallation( /** * List public keys for a user * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-public-keys-for-a-user} + * Learn more at {@link https://docs.github.com/rest/users/keys#list-public-keys-for-a-user} * Tags: users */ export async function usersListPublicKeysForUser( @@ -105556,9 +109544,8 @@ export async function usersListPublicKeysForUser( * * 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. - * Learn more at {@link https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user} + * authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * Learn more at {@link https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user} * Tags: orgs */ export async function orgsListForUser( @@ -105588,7 +109575,7 @@ export async function orgsListForUser( * registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list * of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#list-packages-for-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-packages-for-a-user} * Tags: packages */ export async function packagesListPackagesForUser( @@ -105628,7 +109615,7 @@ export async function packagesListPackagesForUser( * only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub * Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-for-a-user} * Tags: packages */ export async function packagesGetPackageForUser( @@ -105671,7 +109658,7 @@ export async function packagesGetPackageForUser( * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin * permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user} * Tags: packages */ export async function packagesDeletePackageForUser( @@ -105719,7 +109706,7 @@ export async function packagesDeletePackageForUser( * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin * permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user} * Tags: packages */ export async function packagesRestorePackageForUser( @@ -105756,7 +109743,7 @@ export async function packagesRestorePackageForUser( * only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub * Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user} * Tags: packages */ export async function packagesGetAllPackageVersionsForPackageOwnedByUser< @@ -105798,7 +109785,7 @@ export async function packagesGetAllPackageVersionsForPackageOwnedByUser< * the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for * GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user} * Tags: packages */ export async function packagesGetPackageVersionForUser( @@ -105844,7 +109831,7 @@ export async function packagesGetPackageVersionForUser( * permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions * for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user} * Tags: packages */ export async function packagesDeletePackageVersionForUser( @@ -105894,7 +109881,7 @@ export async function packagesDeletePackageVersionForUser( * permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions * for GitHub * Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * Learn more at {@link https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user} + * Learn more at {@link https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user} * Tags: packages */ export async function packagesRestorePackageVersionForUser( @@ -105924,7 +109911,7 @@ export async function packagesRestorePackageVersionForUser( /** * List user projects * Lists projects for a user. - * Learn more at {@link https://docs.github.com/rest/reference/projects#list-user-projects} + * Learn more at {@link https://docs.github.com/rest/projects/projects#list-user-projects} * Tags: projects */ export async function projectsListForUser( @@ -105952,7 +109939,7 @@ export async function projectsListForUser( * List events received by the authenticated user * These are events that you've received by watching repos and following users. If you are authenticated as the given user, * you will see private events. Otherwise, you'll only see public events. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user} * Tags: activity */ export async function activityListReceivedEventsForUser( @@ -105977,7 +109964,7 @@ export async function activityListReceivedEventsForUser( } /** * List public events received by a user - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user} + * Learn more at {@link https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user} * Tags: activity */ export async function activityListReceivedPublicEventsForUser( @@ -106004,7 +109991,7 @@ export async function activityListReceivedPublicEventsForUser( * List repositories for a user * Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for * the specified user. - * Learn more at {@link https://docs.github.com/rest/reference/repos#list-repositories-for-a-user} + * Learn more at {@link https://docs.github.com/rest/repos/repos#list-repositories-for-a-user} * Tags: repos */ export async function reposListForUser( @@ -106044,7 +110031,7 @@ export async function reposListForUser( * * Access * tokens must have the `user` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user} * Tags: billing */ export async function billingGetGithubActionsBillingUser( @@ -106072,7 +110059,7 @@ export async function billingGetGithubActionsBillingUser( * * Access * tokens must have the `user` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user} * Tags: billing */ export async function billingGetGithubPackagesBillingUser( @@ -106100,7 +110087,7 @@ export async function billingGetGithubPackagesBillingUser( * * Access * tokens must have the `user` scope. - * Learn more at {@link https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user} + * Learn more at {@link https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user} * Tags: billing */ export async function billingGetSharedStorageBillingUser( @@ -106145,7 +110132,7 @@ export async function usersListSocialAccountsForUser( /** * List SSH signing keys for a user * Lists the SSH signing keys for a user. This operation is accessible by anyone. - * Learn more at {@link https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user} + * Learn more at {@link https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user} * Tags: users */ export async function usersListSshSigningKeysForUser( @@ -106175,7 +110162,7 @@ export async function usersListSshSigningKeysForUser( * 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: * `application/vnd.github.star+json`. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user} + * Learn more at {@link https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user} * Tags: activity */ export async function activityListReposStarredByUser( @@ -106217,7 +110204,7 @@ export async function activityListReposStarredByUser( /** * List repositories watched by a user * Lists repositories a user is watching. - * Learn more at {@link https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user} + * Learn more at {@link https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user} * Tags: activity */ export async function activityListReposWatchedByUser( @@ -106245,7 +110232,7 @@ export async function activityListReposWatchedByUser( /** * Get all API versions * Get all supported GitHub API versions. - * Learn more at {@link https://docs.github.com/rest/reference/meta#get-all-api-versions} + * Learn more at {@link https://docs.github.com/rest/meta/meta#get-all-api-versions} * Tags: meta */ export async function metaGetAllVersions( @@ -106264,7 +110251,7 @@ export async function metaGetAllVersions( /** * Get the Zen of GitHub * Get a random sentence from the Zen of GitHub - * Learn more at {@link https://docs.github.com/rest/meta#get-the-zen-of-github} + * Learn more at {@link https://docs.github.com/rest/meta/meta#get-the-zen-of-github} * Tags: meta */ export async function metaGetZen( diff --git a/examples/src/stripe.ts b/examples/src/stripe.ts index 5964783..88bddb0 100644 --- a/examples/src/stripe.ts +++ b/examples/src/stripe.ts @@ -465,7 +465,7 @@ export type AccountFutureRequirements = { */ currently_due?: string[] | null; /** - * This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. + * This is typed as a string for consistency with `requirements.disabled_reason`. */ disabled_reason?: string | null; /** @@ -490,7 +490,7 @@ export type AccountFutureRequirements = { * Account Links are the means by which a Connect platform grants a connected account permission to access * Stripe-hosted applications, such as Connect Onboarding. * - * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding) + * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding) */ export type AccountLink = { /** @@ -579,7 +579,7 @@ export type AccountRequirements = { */ currently_due?: string[] | null; /** - * If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. + * If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`. */ disabled_reason?: string | null; /** @@ -621,10 +621,43 @@ export type AccountRequirementsError = { */ code: | 'invalid_address_city_state_postal_code' + | 'invalid_address_highway_contract_box' + | 'invalid_address_private_mailbox' + | 'invalid_business_profile_name' + | 'invalid_business_profile_name_denylisted' + | 'invalid_company_name_denylisted' + | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' + | 'invalid_dob_age_under_minimum' + | 'invalid_product_description_length' + | 'invalid_product_description_url_match' | 'invalid_representative_country' + | 'invalid_statement_descriptor_business_mismatch' + | 'invalid_statement_descriptor_denylisted' + | 'invalid_statement_descriptor_length' + | 'invalid_statement_descriptor_prefix_denylisted' + | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' + | 'invalid_tax_id' + | 'invalid_tax_id_format' | 'invalid_tos_acceptance' + | 'invalid_url_denylisted' + | 'invalid_url_format' + | 'invalid_url_web_presence_detected' + | 'invalid_url_website_business_information_mismatch' + | 'invalid_url_website_empty' + | 'invalid_url_website_inaccessible' + | 'invalid_url_website_inaccessible_geoblocked' + | 'invalid_url_website_inaccessible_password_protected' + | 'invalid_url_website_incomplete' + | 'invalid_url_website_incomplete_cancellation_policy' + | 'invalid_url_website_incomplete_customer_service_details' + | 'invalid_url_website_incomplete_legal_restrictions' + | 'invalid_url_website_incomplete_refund_policy' + | 'invalid_url_website_incomplete_return_policy' + | 'invalid_url_website_incomplete_terms_and_conditions' + | 'invalid_url_website_incomplete_under_construction' + | 'invalid_url_website_other' | 'invalid_value_other' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' @@ -691,6 +724,43 @@ export type AccountSepaDebitPaymentsSettings = { */ creditor_id?: string; }; +/** + * ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession + * An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components. + * + * We recommend that you create an AccountSession each time you need to display an embedded component + * to your user. Do not save AccountSessions to your database as they expire relatively + * quickly, and cannot be used more than once. + * + * Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) + */ +export type AccountSession = { + /** + * The ID of the account the AccountSession was created for + */ + account: string; + /** + * The client secret of this AccountSession. Used on the client to set up secure access to the given `account`. + * + * The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. + * + * Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. + */ + client_secret: string; + components: ConnectEmbeddedAccountSessionCreateComponents; + /** + * The timestamp at which this AccountSession will expire. + */ + expires_at: number; + /** + * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + */ + livemode: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. + */ + object: 'account_session'; +}; /** * AccountSettings */ @@ -831,7 +901,7 @@ export type ApiErrors = { request_log_url?: string; setup_intent?: SetupIntent; /** - * The source object for errors returned on a request involving a source. + * The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source. */ source?: BankAccount | Card | Source; /** @@ -1037,15 +1107,15 @@ export type AutomaticTax = { */ export type Balance = { /** - * Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. + * Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */ available: BalanceAmount[]; /** - * Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. + * Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ connect_reserved?: BalanceAmount[]; /** - * Funds that can be paid out using Instant Payouts. + * Funds that you can pay out using Instant Payouts. */ instant_available?: BalanceAmount[]; issuing?: BalanceDetail; @@ -1058,7 +1128,7 @@ export type Balance = { */ object: 'balance'; /** - * Funds that are not yet available in the balance. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. + * Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. */ pending: BalanceAmount[]; }; @@ -1105,17 +1175,17 @@ export type BalanceDetail = { /** * BalanceTransaction * Balance transactions represent funds moving through your Stripe account. - * They're created for every type of transaction that comes into or flows out of your Stripe account balance. + * Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. * * Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) */ export type BalanceTransaction = { /** - * Gross amount of the transaction, in cents (or local equivalent). + * Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. */ amount: number; /** - * The date the transaction's net funds will become available in the Stripe balance. + * The date that the transaction's net funds become available in the Stripe balance. */ available_on: number; /** @@ -1131,11 +1201,11 @@ export type BalanceTransaction = { */ description?: string | null; /** - * The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. + * If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. */ exchange_rate?: number | null; /** - * Fees (in cents (or local equivalent)) paid for this transaction. + * Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. */ fee: number; /** @@ -1147,7 +1217,7 @@ export type BalanceTransaction = { */ id: string; /** - * Net amount of the transaction, in cents (or local equivalent). + * Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` */ net: number; /** @@ -1155,11 +1225,11 @@ export type BalanceTransaction = { */ object: 'balance_transaction'; /** - * [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. + * Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. */ reporting_category: string; /** - * The Stripe object to which this transaction is related. + * This transaction relates to the Stripe object. */ source?: | ( @@ -1167,6 +1237,7 @@ export type BalanceTransaction = { | ApplicationFee | Charge | ConnectCollectionTransfer + | CustomerCashBalanceTransaction | Dispute | FeeRefund | IssuingAuthorization @@ -1183,11 +1254,11 @@ export type BalanceTransaction = { ) | null; /** - * If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. + * The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; /** - * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. + * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. */ type: | 'adjustment' @@ -1203,6 +1274,12 @@ export type BalanceTransaction = { | 'issuing_authorization_release' | 'issuing_dispute' | 'issuing_transaction' + | 'obligation_inbound' + | 'obligation_outbound' + | 'obligation_payout' + | 'obligation_payout_failure' + | 'obligation_reversal_inbound' + | 'obligation_reversal_outbound' | 'payment' | 'payment_failure_refund' | 'payment_refund' @@ -1280,7 +1357,7 @@ export type BankAccount = { */ fingerprint?: string | null; /** - * Information about upcoming new requirements for the bank account, including what information needs to be collected. + * Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ future_requirements?: ExternalAccountRequirements | null; /** @@ -1613,11 +1690,11 @@ export type BillingPortalSession = { */ export type CancellationDetails = { /** - * Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user. + * Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. */ comment?: string | null; /** - * The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user. + * The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. */ feedback?: | ( @@ -1632,7 +1709,7 @@ export type CancellationDetails = { ) | null; /** - * Why this subscription was cancelled. + * Why this subscription was canceled. */ reason?: | ('cancellation_requested' | 'payment_disputed' | 'payment_failed') @@ -1760,7 +1837,7 @@ export type Card = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -2165,6 +2242,10 @@ export type CheckoutSession = { * Session with your internal systems. */ client_reference_id?: string | null; + /** + * Client secret to be used when initializing Stripe.js embedded checkout. + */ + client_secret?: string | null; /** * Results of `consent_collection` for this session. */ @@ -2192,7 +2273,7 @@ export type CheckoutSession = { custom_text: PaymentPagesCheckoutSessionCustomText; /** * The ID of the customer for this Session. - * For Checkout Sessions in `payment` or `subscription` mode, Checkout + * For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout * will create a new customer object based on information provided * during the payment flow unless an existing customer was provided when * the Session was created. @@ -2330,6 +2411,10 @@ export type CheckoutSession = { * Configure whether a Checkout Session should collect a payment method. */ payment_method_collection?: ('always' | 'if_required') | null; + /** + * Information about the payment method configuration used for this Checkout session if using dynamic payment methods. + */ + payment_method_configuration_details?: PaymentMethodConfigBizPaymentMethodConfigurationDetails | null; /** * Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ @@ -2349,6 +2434,14 @@ export type CheckoutSession = { * The ID of the original expired Checkout Session that triggered the recovery flow. */ recovered_from?: string | null; + /** + * Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method. + */ + redirect_on_completion?: 'always' | 'if_required' | 'never'; + /** + * Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. + */ + return_url?: string; /** * The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ @@ -2394,6 +2487,10 @@ export type CheckoutSession = { * Tax and discount details for the computed total amount. */ total_details?: PaymentPagesCheckoutSessionTotalDetails | null; + /** + * The UI mode of the Session. Can be `hosted` (default) or `embedded`. + */ + ui_mode?: ('embedded' | 'hosted') | null; /** * The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` * This value is only present when the session is active. @@ -2900,6 +2997,21 @@ export type ConnectCollectionTransfer = { */ object: 'connect_collection_transfer'; }; +/** + * ConnectEmbeddedAccountSessionCreateComponents + */ +export type ConnectEmbeddedAccountSessionCreateComponents = { + account_onboarding: ConnectEmbeddedBaseConfigClaim; +}; +/** + * ConnectEmbeddedBaseConfigClaim + */ +export type ConnectEmbeddedBaseConfigClaim = { + /** + * Whether the embedded component is enabled. + */ + enabled: boolean; +}; /** * CountrySpec * Stripe needs to collect certain pieces of information about each account @@ -3364,7 +3476,7 @@ export type CustomUnitAmount = { }; /** * Customer - * This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. + * This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. * * Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment) */ @@ -3374,11 +3486,11 @@ export type Customer = { */ address?: Address | null; /** - * Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. + * The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. */ balance?: number; /** - * The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically. + * The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. */ cash_balance?: CashBalance | null; /** @@ -3392,13 +3504,15 @@ export type Customer = { /** * ID of the default payment source for the customer. * - * If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. + * If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. */ default_source?: (string | BankAccount | Card | Source) | null; /** - * When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. + * Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. + * + * If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`. * - * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. + * If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. */ delinquent?: boolean | null; /** @@ -3418,7 +3532,7 @@ export type Customer = { */ id: string; /** - * The current multi-currency balances, if any, being stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that will be added to their next invoice denominated in that currency. These balances do not refer to any unpaid invoices. They solely track amounts that have yet to be successfully applied to any invoice. A balance in a particular currency is only applied to any invoice as an invoice in that currency is finalized. + * The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. */ invoice_credit_balance?: { [key: string]: number; @@ -3443,7 +3557,7 @@ export type Customer = { */ name?: string | null; /** - * The suffix of the customer's next invoice number, e.g., 0001. + * The suffix of the customer's next invoice number (for example, 0001). */ next_invoice_sequence?: number; /** @@ -3508,7 +3622,7 @@ export type Customer = { }; tax?: CustomerTax; /** - * Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. + * Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. */ tax_exempt?: ('exempt' | 'none' | 'reverse') | null; /** @@ -3534,7 +3648,7 @@ export type Customer = { url: string; }; /** - * ID of the test clock this customer belongs to. + * ID of the test clock that this customer belongs to. */ test_clock?: (string | TestHelpersTestClock) | null; }; @@ -3543,13 +3657,13 @@ export type Customer = { */ export type CustomerAcceptance = { /** - * The time at which the customer accepted the Mandate. + * The time that the customer accepts the mandate. */ accepted_at?: number | null; offline?: OfflineAcceptance; online?: OnlineAcceptance; /** - * The type of customer acceptance information included with the Mandate. One of `online` or `offline`. + * The mandate includes the type of customer acceptance information, such as: `online` or `offline`. */ type: 'offline' | 'online'; }; @@ -3572,7 +3686,7 @@ export type CustomerBalanceCustomerBalanceSettings = { export type CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft = { /** - * The [Balance Transaction](docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. + * The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. */ balance_transaction: string | BalanceTransaction; /** @@ -4389,16 +4503,14 @@ export type DiscountsResourceDiscountAmount = { /** * Dispute * A dispute occurs when a customer questions your charge with their card issuer. - * When this happens, you're given the opportunity to respond to the dispute with - * evidence that shows that the charge is legitimate. You can find more - * information about the dispute process in our [Disputes and - * Fraud](/docs/disputes) documentation. + * When this happens, you have the opportunity to respond to the dispute with + * evidence that shows that the charge is legitimate. * * Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) */ export type Dispute = { /** - * Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). + * Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). */ amount: number; /** @@ -4406,7 +4518,7 @@ export type Dispute = { */ balance_transactions: BalanceTransaction[]; /** - * ID of the charge that was disputed. + * ID of the charge that's disputed. */ charge: string | Charge; /** @@ -4424,7 +4536,7 @@ export type Dispute = { */ id: string; /** - * If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. + * If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. */ is_charge_refundable: boolean; /** @@ -4442,12 +4554,12 @@ export type Dispute = { */ object: 'dispute'; /** - * ID of the PaymentIntent that was disputed. + * ID of the PaymentIntent that's disputed. */ payment_intent?: (string | PaymentIntent) | null; payment_method_details?: DisputePaymentMethodDetails; /** - * Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). + * Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ reason: string; /** @@ -4675,40 +4787,41 @@ export type Error = { * Events are our way of letting you know when something interesting happens in * your account. When an interesting event occurs, we create a new `Event` * object. For example, when a charge succeeds, we create a `charge.succeeded` - * event; and when an invoice payment attempt fails, we create an - * `invoice.payment_failed` event. Note that many API requests may cause multiple - * events to be created. For example, if you create a new subscription for a - * customer, you will receive both a `customer.subscription.created` event and a + * event, and when an invoice payment attempt fails, we create an + * `invoice.payment_failed` event. Certain API requests might create multiple + * events. For example, if you create a new subscription for a + * customer, you receive both a `customer.subscription.created` event and a * `charge.succeeded` event. * - * Events occur when the state of another API resource changes. The state of that - * resource at the time of the change is embedded in the event's data field. For - * example, a `charge.succeeded` event will contain a charge, and an - * `invoice.payment_failed` event will contain an invoice. + * Events occur when the state of another API resource changes. The event's data + * field embeds the resource's state at the time of the change. For + * example, a `charge.succeeded` event contains a charge, and an + * `invoice.payment_failed` event contains an invoice. * * As with other API resources, you can use endpoints to retrieve an * [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events) * from the API. We also have a separate * [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the - * `Event` objects directly to an endpoint on your server. Webhooks are managed - * in your - * [account settings](https://dashboard.stripe.com/account/webhooks), - * and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up. + * `Event` objects directly to an endpoint on your server. You can manage + * webhooks in your + * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how + * to [listen for events] + * (/docs/webhooks) so that your integration can automatically trigger reactions. * - * When using [Connect](https://stripe.com/docs/connect), you can also receive notifications of - * events that occur in connected accounts. For these events, there will be an + * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications + * that occur in connected accounts. For these events, there's an * additional `account` attribute in the received `Event` object. * - * **NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is - * guaranteed only for 30 days. + * We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) + * for 30 days. */ export type Event = { /** - * The connected account that originated the event. + * The connected account that originates the event. */ account?: string; /** - * The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. + * The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ api_version?: string | null; /** @@ -4729,15 +4842,15 @@ export type Event = { */ object: 'event'; /** - * Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. + * Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. */ pending_webhooks: number; /** - * Information on the API request that instigated the event. + * Information on the API request that triggers the event. */ request?: NotificationEventRequest | null; /** - * Description of the event (e.g., `invoice.created` or `charge.refunded`). + * Description of the event (for example, `invoice.created` or `charge.refunded`). */ type: string; }; @@ -4867,10 +4980,10 @@ export type FeeRefund = { }; /** * File - * This is an object representing a file hosted on Stripe's servers. The - * file may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file) - * request (for example, when uploading dispute evidence) or it may have - * been created by Stripe (for example, the results of a [Sigma scheduled + * This object represents files hosted on Stripe's servers. You can upload + * files with the [create file](https://stripe.com/docs/api#create_file) request + * (for example, when uploading dispute evidence). Stripe also + * creates files independetly (for example, the results of a [Sigma scheduled * query](#scheduled_queries)). * * Related guide: [File upload guide](https://stripe.com/docs/file-upload) @@ -4881,11 +4994,11 @@ export type File = { */ created: number; /** - * The time at which the file expires and is no longer available in epoch seconds. + * The file expires and isn't available at this time in epoch seconds. */ expires_at?: number | null; /** - * A filename for the file, suitable for saving to a filesystem. + * The suitable name for saving the file to a filesystem. */ filename?: string | null; /** @@ -4893,7 +5006,7 @@ export type File = { */ id: string; /** - * FileFileLinkList + * FileResourceFileLinkList * A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { @@ -4938,26 +5051,26 @@ export type File = { | 'tax_document_user_upload' | 'terminal_reader_splashscreen'; /** - * The size in bytes of the file object. + * The size of the file object in bytes. */ size: number; /** - * A user friendly title for the document. + * A suitable title for the document. */ title?: string | null; /** - * The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). + * The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). */ type?: string | null; /** - * The URL from which the file can be downloaded using your live secret API key. + * Use your live secret API key to download the file from this URL. */ url?: string | null; }; /** * FileLink * To share the contents of a `File` object with non-Stripe users, you can - * create a `FileLink`. `FileLink`s contain a URL that can be used to + * create a `FileLink`. `FileLink`s contain a URL that you can use to * retrieve the contents of the file without authentication. */ export type FileLink = { @@ -4966,11 +5079,11 @@ export type FileLink = { */ created: number; /** - * Whether this link is already expired. + * Returns if the link is already expired. */ expired: boolean; /** - * Time at which the link expires. + * Time that the link expires. */ expires_at?: number | null; /** @@ -5225,6 +5338,10 @@ export type FinancialConnectionsSession = { * Permissions requested for accounts collected during this session. */ permissions: ('balances' | 'ownership' | 'payment_method' | 'transactions')[]; + /** + * Data features requested to be retrieved upon account creation. + */ + prefetch?: ('balances' | 'ownership')[] | null; /** * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ @@ -6052,7 +6169,15 @@ export type Invoice = { auto_advance?: boolean; automatic_tax: AutomaticTax; /** - * Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. + * Indicates the reason why the invoice was created. + * + * * `manual`: Unrelated to a subscription, for example, created via the invoice editor. + * * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. + * * `subscription_create`: A new subscription was created. + * * `subscription_cycle`: A subscription advanced into a new period. + * * `subscription_threshold`: A subscription reached a billing threshold. + * * `subscription_update`: A subscription was updated. + * * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint. */ billing_reason?: | ( @@ -6269,9 +6394,9 @@ export type Invoice = { */ receipt_number?: string | null; /** - * Options for invoice PDF rendering. + * The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ - rendering_options?: InvoiceSettingRenderingOptions | null; + rendering?: InvoicesInvoiceRendering | null; /** * The details of the cost of shipping, including the ShippingRate applied on the invoice. */ @@ -6489,6 +6614,19 @@ export type InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptions = { * The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ('balances' | 'payment_method' | 'transactions')[]; + /** + * Data features requested to be retrieved upon account creation. + */ + prefetch?: 'balances'[] | null; +}; +/** + * InvoiceRenderingPdf + */ +export type InvoiceRenderingPdf = { + /** + * Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. + */ + page_size?: ('a4' | 'auto' | 'letter') | null; }; /** * InvoiceSettingCustomField @@ -6745,6 +6883,19 @@ export type InvoicesFromInvoice = { */ invoice: string | Invoice; }; +/** + * InvoicesInvoiceRendering + */ +export type InvoicesInvoiceRendering = { + /** + * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ + amount_tax_display?: string | null; + /** + * Invoice pdf rendering options + */ + pdf?: InvoiceRenderingPdf | null; +}; /** * InvoicesPaymentMethodOptions */ @@ -7055,6 +7206,10 @@ export type IssuingAuthorization = { * The current status of the authorization in its lifecycle. */ status: 'closed' | 'pending' | 'reversed'; + /** + * [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. + */ + token?: (string | IssuingToken) | null; /** * List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ @@ -7359,6 +7514,57 @@ export type IssuingSettlement = { */ transaction_volume: number; }; +/** + * IssuingNetworkToken + * An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe. + */ +export type IssuingToken = { + /** + * Card associated with this token. + */ + card: string | IssuingCard; + /** + * Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** + * The hashed ID derived from the device ID from the card network associated with the token + */ + device_fingerprint?: string | null; + /** + * Unique identifier for the object. + */ + id: string; + /** + * The last four digits of the token. + */ + last4?: string; + /** + * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + */ + livemode: boolean; + /** + * The token service provider / card network associated with the token. + */ + network: 'mastercard' | 'visa'; + network_data?: IssuingNetworkTokenNetworkData; + /** + * Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. + */ + network_updated_at: number; + /** + * String representing the object's type. Objects of the same type share the same value. + */ + object: 'issuing.token'; + /** + * The usage state of the token. + */ + status: 'active' | 'deleted' | 'requested' | 'suspended'; + /** + * The digital wallet for this token, if one was used. + */ + wallet_provider?: 'apple_pay' | 'google_pay' | 'samsung_pay'; +}; /** * IssuingTransaction * Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -7435,6 +7641,10 @@ export type IssuingTransaction = { * Additional purchase information that is optionally provided by the merchant. */ purchase_details?: IssuingTransactionPurchaseDetails | null; + /** + * [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. + */ + token?: (string | IssuingToken) | null; /** * [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ @@ -7456,6 +7666,10 @@ export type IssuingAuthorizationAmountDetails = { * The fee charged by the ATM for the cash withdrawal. */ atm_fee?: number | null; + /** + * The amount of cash requested by the cardholder. + */ + cashback_amount?: number | null; }; /** * IssuingAuthorizationMerchantData @@ -7552,6 +7766,10 @@ export type IssuingAuthorizationRequest = { * Whether this request was approved. */ approved: boolean; + /** + * A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. + */ + authorization_code?: string | null; /** * Time at which the object was created. Measured in seconds since the Unix epoch. */ @@ -7628,6 +7846,10 @@ export type IssuingAuthorizationVerificationData = { * Whether the cardholder provided an expiry date and if it matched Stripe’s record. */ expiry_check: 'match' | 'mismatch' | 'not_provided'; + /** + * The postal code submitted as part of the authorization used for postal code verification. + */ + postal_code?: string | null; }; /** * IssuingCardApplePay @@ -8306,7 +8528,7 @@ export type IssuingCardShipping = { */ name: string; /** - * The phone number of the receiver of the bulk shipment. This phone number will be provided to the shipping company, who might use it to contact the receiver in case of delivery issues. + * The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. */ phone_number?: string | null; /** @@ -9977,6 +10199,174 @@ export type IssuingDisputeTreasury = { */ received_debit: string; }; +/** + * IssuingNetworkTokenAddress + */ +export type IssuingNetworkTokenAddress = { + /** + * The street address of the cardholder tokenizing the card. + */ + line1: string; + /** + * The postal code of the cardholder tokenizing the card. + */ + postal_code: string; +}; +/** + * IssuingNetworkTokenDevice + */ +export type IssuingNetworkTokenDevice = { + /** + * An obfuscated ID derived from the device ID. + */ + device_fingerprint?: string; + /** + * The IP address of the device at provisioning time. + */ + ip_address?: string; + /** + * The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal. + */ + location?: string; + /** + * The name of the device used for tokenization. + */ + name?: string; + /** + * The phone number of the device used for tokenization. + */ + phone_number?: string; + /** + * The type of device used for tokenization. + */ + type?: 'other' | 'phone' | 'watch'; +}; +/** + * IssuingNetworkTokenMastercard + */ +export type IssuingNetworkTokenMastercard = { + /** + * A unique reference ID from MasterCard to represent the card account number. + */ + card_reference_id?: string; + /** + * The network-unique identifier for the token. + */ + token_reference_id: string; + /** + * The ID of the entity requesting tokenization, specific to MasterCard. + */ + token_requestor_id: string; + /** + * The name of the entity requesting tokenization, if known. This is directly provided from MasterCard. + */ + token_requestor_name?: string; +}; +/** + * IssuingNetworkTokenNetworkData + */ +export type IssuingNetworkTokenNetworkData = { + device?: IssuingNetworkTokenDevice; + mastercard?: IssuingNetworkTokenMastercard; + /** + * The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network. + */ + type: 'mastercard' | 'visa'; + visa?: IssuingNetworkTokenVisa; + wallet_provider?: IssuingNetworkTokenWalletProvider; +}; +/** + * IssuingNetworkTokenVisa + */ +export type IssuingNetworkTokenVisa = { + /** + * A unique reference ID from Visa to represent the card account number. + */ + card_reference_id: string; + /** + * The network-unique identifier for the token. + */ + token_reference_id: string; + /** + * The ID of the entity requesting tokenization, specific to Visa. + */ + token_requestor_id: string; + /** + * Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa. + */ + token_risk_score?: string; +}; +/** + * IssuingNetworkTokenWalletProvider + */ +export type IssuingNetworkTokenWalletProvider = { + /** + * The wallet provider-given account ID of the digital wallet the token belongs to. + */ + account_id?: string; + /** + * An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy. + */ + account_trust_score?: number; + /** + * The method used for tokenizing a card. + */ + card_number_source?: 'app' | 'manual' | 'on_file' | 'other'; + cardholder_address?: IssuingNetworkTokenAddress; + /** + * The name of the cardholder tokenizing the card. + */ + cardholder_name?: string; + /** + * An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy. + */ + device_trust_score?: number; + /** + * The hashed email address of the cardholder's account with the wallet provider. + */ + hashed_account_email_address?: string; + /** + * The reasons for suggested tokenization given by the card network. + */ + reason_codes?: ( + | 'account_card_too_new' + | 'account_recently_changed' + | 'account_too_new' + | 'account_too_new_since_launch' + | 'additional_device' + | 'data_expired' + | 'defer_id_v_decision' + | 'device_recently_lost' + | 'good_activity_history' + | 'has_suspended_tokens' + | 'high_risk' + | 'inactive_account' + | 'long_account_tenure' + | 'low_account_score' + | 'low_device_score' + | 'low_phone_number_score' + | 'network_service_error' + | 'outside_home_territory' + | 'provisioning_cardholder_mismatch' + | 'provisioning_device_and_cardholder_mismatch' + | 'provisioning_device_mismatch' + | 'same_device_no_prior_authentication' + | 'same_device_successful_prior_authentication' + | 'software_update' + | 'suspicious_activity' + | 'too_many_different_cardholders' + | 'too_many_recent_attempts' + | 'too_many_recent_tokens' + )[]; + /** + * The recommendation on responding to the tokenization request. + */ + suggested_decision?: 'approve' | 'decline' | 'require_auth'; + /** + * The version of the standard for mapping reason codes followed by the wallet provider. + */ + suggested_decision_version?: string; +}; /** * IssuingTransactionAmountDetails */ @@ -9985,6 +10375,10 @@ export type IssuingTransactionAmountDetails = { * The fee charged by the ATM for the cash withdrawal. */ atm_fee?: number | null; + /** + * The amount of cash requested by the cardholder. + */ + cashback_amount?: number | null; }; /** * IssuingTransactionFlightData @@ -10575,6 +10969,10 @@ export type LinkedAccountOptionsUsBankAccount = { | 'payment_method' | 'transactions' )[]; + /** + * Data features requested to be retrieved upon account creation. + */ + prefetch?: 'balances'[] | null; /** * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ @@ -10600,7 +10998,7 @@ export type LoginLink = { }; /** * Mandate - * A Mandate is a record of the permission a customer has given you to debit their payment method. + * A Mandate is a record of the permission that your customer gives you to debit their payment method. */ export type Mandate = { customer_acceptance: CustomerAcceptance; @@ -10618,7 +11016,7 @@ export type Mandate = { */ object: 'mandate'; /** - * The account (if any) for which the mandate is intended. + * The account (if any) that the mandate is intended for. */ on_behalf_of?: string; /** @@ -10628,7 +11026,7 @@ export type Mandate = { payment_method_details: MandatePaymentMethodDetails; single_use?: MandateSingleUse; /** - * The status of the mandate, which indicates whether it can be used to initiate a payment. + * The mandate status indicates whether or not you can use it to initiate a payment. */ status: 'active' | 'inactive' | 'pending'; /** @@ -10708,7 +11106,7 @@ export type MandatePaymentMethodDetails = { paypal?: MandatePaypal; sepa_debit?: MandateSepaDebit; /** - * The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. + * This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. */ type: string; us_bank_account?: MandateUsBankAccount; @@ -10744,11 +11142,11 @@ export type MandateSepaDebit = { */ export type MandateSingleUse = { /** - * On a single use mandate, the amount of the payment. + * The amount of the payment on a single use mandate. */ amount: number; /** - * On a single use mandate, the currency of the payment. + * The currency of the payment on a single use mandate. */ currency: string; }; @@ -10804,11 +11202,11 @@ export type OfflineAcceptance = any; */ export type OnlineAcceptance = { /** - * The IP address from which the Mandate was accepted by the customer. + * The customer accepts the mandate from this IP address. */ ip_address?: string | null; /** - * The user agent of the browser from which the Mandate was accepted by the customer. + * The customer accepts the mandate using the user agent of the browser. */ user_agent?: string | null; }; @@ -11008,6 +11406,50 @@ export type PaymentFlowsPrivatePaymentMethodsAlipayDetails = { */ transaction_id?: string | null; }; +/** + * PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization + */ +export type PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization = + { + /** + * Indicates whether or not the capture window is extended beyond the standard authorization. + */ + status: 'disabled' | 'enabled'; + }; +/** + * PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization + */ +export type PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization = + { + /** + * Indicates whether or not the incremental authorization feature is supported. + */ + status: 'available' | 'unavailable'; + }; +/** + * PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture + */ +export type PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercapture = + { + /** + * The maximum amount that can be captured. + */ + maximum_amount_capturable: number; + /** + * Indicates whether or not the authorized amount can be over-captured. + */ + status: 'available' | 'unavailable'; + }; +/** + * PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture + */ +export type PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticapture = + { + /** + * Indicates whether or not multiple captures are supported. + */ + status: 'available' | 'unavailable'; + }; /** * PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ @@ -11050,7 +11492,7 @@ export type PaymentIntent = { amount_capturable?: number; amount_details?: PaymentFlowsAmountDetails; /** - * Amount that was collected by this PaymentIntent. + * Amount that this PaymentIntent collects. */ amount_received?: number; /** @@ -11129,7 +11571,7 @@ export type PaymentIntent = { */ last_payment_error?: ApiErrors | null; /** - * The latest charge created by this payment intent. + * The latest charge created by this PaymentIntent. */ latest_charge?: (string | Charge) | null; /** @@ -11137,7 +11579,7 @@ export type PaymentIntent = { */ livemode: boolean; /** - * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ metadata?: { [key: string]: string; @@ -11158,6 +11600,10 @@ export type PaymentIntent = { * ID of the payment method used in this PaymentIntent. */ payment_method?: (string | PaymentMethod) | null; + /** + * Information about the payment method configuration used for this PaymentIntent. + */ + payment_method_configuration_details?: PaymentMethodConfigBizPaymentMethodConfigurationDetails | null; /** * Payment-method-specific configuration for this PaymentIntent. */ @@ -11210,11 +11656,11 @@ export type PaymentIntent = { | 'requires_payment_method' | 'succeeded'; /** - * The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: TransferData | null; /** - * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + * A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ transfer_group?: string | null; }; @@ -11815,6 +12261,22 @@ export type PaymentIntentPaymentMethodOptionsCard = { | 'visa' ) | null; + /** + * Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. + */ + request_extended_authorization?: 'if_available' | 'never'; + /** + * Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + */ + request_incremental_authorization?: 'if_available' | 'never'; + /** + * Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + */ + request_multicapture?: 'if_available' | 'never'; + /** + * Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + */ + request_overcapture?: 'if_available' | 'never'; /** * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ @@ -11990,6 +12452,10 @@ export type PaymentLink = { * Whether user redeemable promotion codes are enabled. */ allow_promotion_codes: boolean; + /** + * The ID of the Connect application that created the Payment Link. + */ + application?: (string | Application | DeletedApplication) | null; /** * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. */ @@ -12193,27 +12659,18 @@ export type PaymentLinksResourceConsentCollection = { * PaymentLinksResourceCustomFields */ export type PaymentLinksResourceCustomFields = { - /** - * Configuration for `type=dropdown` fields. - */ - dropdown?: PaymentLinksResourceCustomFieldsDropdown | null; + dropdown?: PaymentLinksResourceCustomFieldsDropdown; /** * String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ key: string; label: PaymentLinksResourceCustomFieldsLabel; - /** - * Configuration for `type=numeric` fields. - */ - numeric?: PaymentLinksResourceCustomFieldsNumeric | null; + numeric?: PaymentLinksResourceCustomFieldsNumeric; /** * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ optional: boolean; - /** - * Configuration for `type=text` fields. - */ - text?: PaymentLinksResourceCustomFieldsText | null; + text?: PaymentLinksResourceCustomFieldsText; /** * The type of the field. */ @@ -12292,13 +12749,17 @@ export type PaymentLinksResourceCustomText = { * Custom text that should be displayed alongside the payment confirmation button. */ submit?: PaymentLinksResourceCustomTextPosition | null; + /** + * Custom text that should be displayed in place of the default terms of service agreement text. + */ + terms_of_service_acceptance?: PaymentLinksResourceCustomTextPosition | null; }; /** * PaymentLinksResourceCustomTextPosition */ export type PaymentLinksResourceCustomTextPosition = { /** - * Text may be up to 1000 characters in length. + * Text may be up to 1200 characters in length. */ message: string; }; @@ -12354,10 +12815,24 @@ export type PaymentLinksResourcePaymentIntentData = { * Indicates when the funds will be captured from the customer's account. */ capture_method?: ('automatic' | 'automatic_async' | 'manual') | null; + /** + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. + */ + metadata: { + [key: string]: string; + }; /** * Indicates that you intend to make future payments with the payment method collected during checkout. */ setup_future_usage?: ('off_session' | 'on_session') | null; + /** + * Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. + */ + statement_descriptor?: string | null; + /** + * Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. + */ + statement_descriptor_suffix?: string | null; }; /** * PaymentLinksResourcePhoneNumberCollection @@ -12633,9 +13108,15 @@ export type PaymentLinksResourceShippingOption = { */ export type PaymentLinksResourceSubscriptionData = { /** - * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. + * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; + /** + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. + */ + metadata: { + [key: string]: string; + }; /** * Integer representing the number of trial period days before the customer is charged for the first time. */ @@ -12882,7 +13363,7 @@ export type PaymentMethodCard = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -12971,7 +13452,7 @@ export type PaymentMethodCardPresent = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -13114,6 +13595,134 @@ export type PaymentMethodCashapp = { */ cashtag?: string | null; }; +/** + * PaymentMethodConfigBizPaymentMethodConfigurationDetails + */ +export type PaymentMethodConfigBizPaymentMethodConfigurationDetails = { + /** + * ID of the payment method configuration used. + */ + id: string; + /** + * ID of the parent payment method configuration used. + */ + parent?: string | null; +}; +/** + * PaymentMethodConfigResourceDisplayPreference + */ +export type PaymentMethodConfigResourceDisplayPreference = { + /** + * For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + */ + overridable?: boolean | null; + /** + * The account's display preference. + */ + preference: 'none' | 'off' | 'on'; + /** + * The effective display preference value. + */ + value: 'off' | 'on'; +}; +/** + * PaymentMethodConfigResourcePaymentMethodProperties + */ +export type PaymentMethodConfigResourcePaymentMethodProperties = { + /** + * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + */ + available: boolean; + display_preference: PaymentMethodConfigResourceDisplayPreference; +}; +/** + * PaymentMethodConfigResourcePaymentMethodConfiguration + * PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. + * + * There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges): + * + * **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. + * + * **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter. + * + * Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. + * + * Related guides: + * - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) + * - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) + * - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations) + */ +export type PaymentMethodConfiguration = { + acss_debit?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * Whether the configuration can be used for new payments. + */ + active: boolean; + affirm?: PaymentMethodConfigResourcePaymentMethodProperties; + afterpay_clearpay?: PaymentMethodConfigResourcePaymentMethodProperties; + alipay?: PaymentMethodConfigResourcePaymentMethodProperties; + apple_pay?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * For child configs, the Connect application associated with the configuration. + */ + application?: string | null; + au_becs_debit?: PaymentMethodConfigResourcePaymentMethodProperties; + bacs_debit?: PaymentMethodConfigResourcePaymentMethodProperties; + bancontact?: PaymentMethodConfigResourcePaymentMethodProperties; + blik?: PaymentMethodConfigResourcePaymentMethodProperties; + boleto?: PaymentMethodConfigResourcePaymentMethodProperties; + card?: PaymentMethodConfigResourcePaymentMethodProperties; + cartes_bancaires?: PaymentMethodConfigResourcePaymentMethodProperties; + cashapp?: PaymentMethodConfigResourcePaymentMethodProperties; + eps?: PaymentMethodConfigResourcePaymentMethodProperties; + fpx?: PaymentMethodConfigResourcePaymentMethodProperties; + giropay?: PaymentMethodConfigResourcePaymentMethodProperties; + google_pay?: PaymentMethodConfigResourcePaymentMethodProperties; + grabpay?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * Unique identifier for the object. + */ + id: string; + id_bank_transfer?: PaymentMethodConfigResourcePaymentMethodProperties; + ideal?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * The default configuration is used whenever a payment method configuration is not specified. + */ + is_default: boolean; + jcb?: PaymentMethodConfigResourcePaymentMethodProperties; + klarna?: PaymentMethodConfigResourcePaymentMethodProperties; + konbini?: PaymentMethodConfigResourcePaymentMethodProperties; + link?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + */ + livemode: boolean; + multibanco?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * The configuration's name. + */ + name: string; + netbanking?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * String representing the object's type. Objects of the same type share the same value. + */ + object: 'payment_method_configuration'; + oxxo?: PaymentMethodConfigResourcePaymentMethodProperties; + p24?: PaymentMethodConfigResourcePaymentMethodProperties; + /** + * For child configs, the configuration's parent configuration. + */ + parent?: string | null; + pay_by_bank?: PaymentMethodConfigResourcePaymentMethodProperties; + paynow?: PaymentMethodConfigResourcePaymentMethodProperties; + paypal?: PaymentMethodConfigResourcePaymentMethodProperties; + promptpay?: PaymentMethodConfigResourcePaymentMethodProperties; + sepa_debit?: PaymentMethodConfigResourcePaymentMethodProperties; + sofort?: PaymentMethodConfigResourcePaymentMethodProperties; + upi?: PaymentMethodConfigResourcePaymentMethodProperties; + us_bank_account?: PaymentMethodConfigResourcePaymentMethodProperties; + wechat_pay?: PaymentMethodConfigResourcePaymentMethodProperties; +}; /** * payment_method_customer_balance */ @@ -13361,6 +13970,10 @@ export type PaymentMethodDetailsBoleto = { * payment_method_details_card */ export type PaymentMethodDetailsCard = { + /** + * The authorized amount. + */ + amount_authorized?: number | null; /** * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ @@ -13381,16 +13994,18 @@ export type PaymentMethodDetailsCard = { * Four-digit number representing the card's expiration year. */ exp_year: number; + extended_authorization?: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization; /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ funding?: string | null; + incremental_authorization?: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization; /** * Installment details for this payment (Mexico only). * @@ -13405,6 +14020,7 @@ export type PaymentMethodDetailsCard = { * ID of the mandate used to make this payment or created by it. */ mandate?: string | null; + multicapture?: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticapture; /** * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ @@ -13413,6 +14029,7 @@ export type PaymentMethodDetailsCard = { * If this card has network token credentials, this contains the details of the network token credentials. */ network_token?: PaymentMethodDetailsCardNetworkToken | null; + overcapture?: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercapture; /** * Populated if this transaction used 3D Secure authentication. */ @@ -13514,7 +14131,7 @@ export type PaymentMethodDetailsCardPresent = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -13823,7 +14440,7 @@ export type PaymentMethodDetailsGrabpay = { */ export type PaymentMethodDetailsIdeal = { /** - * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ bank?: | ( @@ -13834,6 +14451,7 @@ export type PaymentMethodDetailsIdeal = { | 'ing' | 'knab' | 'moneyou' + | 'n26' | 'rabobank' | 'regiobank' | 'revolut' @@ -13857,6 +14475,7 @@ export type PaymentMethodDetailsIdeal = { | 'INGBNL2A' | 'KNABNL2H' | 'MOYONL21' + | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' @@ -13914,7 +14533,7 @@ export type PaymentMethodDetailsInteracPresent = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -14287,6 +14906,64 @@ export type PaymentMethodDetailsWechatPay = { * payment_method_details_zip */ export type PaymentMethodDetailsZip = any; +/** + * PaymentMethodDomainResourcePaymentMethodDomain + * A payment method domain represents a web domain that you have registered with Stripe. + * Stripe Elements use registered payment method domains to control where certain payment methods are shown. + * + * Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + */ +export type PaymentMethodDomain = { + apple_pay: PaymentMethodDomainResourcePaymentMethodStatus; + /** + * Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** + * The domain name that this payment method domain object represents. + */ + domain_name: string; + /** + * Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. + */ + enabled: boolean; + google_pay: PaymentMethodDomainResourcePaymentMethodStatus; + /** + * Unique identifier for the object. + */ + id: string; + link: PaymentMethodDomainResourcePaymentMethodStatus; + /** + * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + */ + livemode: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. + */ + object: 'payment_method_domain'; + paypal: PaymentMethodDomainResourcePaymentMethodStatus; +}; +/** + * PaymentMethodDomainResourcePaymentMethodStatus + * Indicates the status of a specific payment method on a payment method domain. + */ +export type PaymentMethodDomainResourcePaymentMethodStatus = { + /** + * The status of the payment method on the domain. + */ + status: 'active' | 'inactive'; + status_details?: PaymentMethodDomainResourcePaymentMethodStatusDetails; +}; +/** + * PaymentMethodDomainResourcePaymentMethodStatusDetails + * Contains additional details about the status of a payment method for a specific payment method domain. + */ +export type PaymentMethodDomainResourcePaymentMethodStatusDetails = { + /** + * The error message associated with the status of the payment method on the domain. + */ + error_message: string; +}; /** * payment_method_eps */ @@ -14371,7 +15048,7 @@ export type PaymentMethodGrabpay = any; */ export type PaymentMethodIdeal = { /** - * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ bank?: | ( @@ -14382,6 +15059,7 @@ export type PaymentMethodIdeal = { | 'ing' | 'knab' | 'moneyou' + | 'n26' | 'rabobank' | 'regiobank' | 'revolut' @@ -14405,6 +15083,7 @@ export type PaymentMethodIdeal = { | 'INGBNL2A' | 'KNABNL2H' | 'MOYONL21' + | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' @@ -14441,7 +15120,7 @@ export type PaymentMethodInteracPresent = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -14525,8 +15204,8 @@ export type PaymentMethodOptionsAfterpayClearpay = { */ capture_method?: 'manual'; /** - * Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about - * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. + * An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. + * This field differs from the statement descriptor and item name. */ reference?: string | null; /** @@ -15300,27 +15979,18 @@ export type PaymentPagesCheckoutSessionCurrencyConversion = { * PaymentPagesCheckoutSessionCustomFields */ export type PaymentPagesCheckoutSessionCustomFields = { - /** - * Configuration for `type=dropdown` fields. - */ - dropdown?: PaymentPagesCheckoutSessionCustomFieldsDropdown | null; + dropdown?: PaymentPagesCheckoutSessionCustomFieldsDropdown; /** * String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ key: string; label: PaymentPagesCheckoutSessionCustomFieldsLabel; - /** - * Configuration for `type=numeric` fields. - */ - numeric?: PaymentPagesCheckoutSessionCustomFieldsNumeric | null; + numeric?: PaymentPagesCheckoutSessionCustomFieldsNumeric; /** * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ optional: boolean; - /** - * Configuration for `type=text` fields. - */ - text?: PaymentPagesCheckoutSessionCustomFieldsText | null; + text?: PaymentPagesCheckoutSessionCustomFieldsText; /** * The type of the field. */ @@ -15411,13 +16081,17 @@ export type PaymentPagesCheckoutSessionCustomText = { * Custom text that should be displayed alongside the payment confirmation button. */ submit?: PaymentPagesCheckoutSessionCustomTextPosition | null; + /** + * Custom text that should be displayed in place of the default terms of service agreement text. + */ + terms_of_service_acceptance?: PaymentPagesCheckoutSessionCustomTextPosition | null; }; /** * PaymentPagesCheckoutSessionCustomTextPosition */ export type PaymentPagesCheckoutSessionCustomTextPosition = { /** - * Text may be up to 1000 characters in length. + * Text may be up to 1200 characters in length. */ message: string; }; @@ -15916,7 +16590,7 @@ export type PaymentSource = Account | BankAccount | Card | Source; * A `Payout` object is created when you receive funds from Stripe, or when you * initiate a payout to either a bank account or debit card of a [connected * Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, - * as well as list all payouts. Payouts are made on [varying + * and list all payouts. Payouts are made on [varying * schedules](/docs/connect/manage-payout-schedule), depending on your country and * industry. * @@ -15924,15 +16598,15 @@ export type PaymentSource = Account | BankAccount | Card | Source; */ export type Payout = { /** - * Amount (in cents (or local equivalent)) to be transferred to your bank account or debit card. + * The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */ amount: number; /** - * Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. + * Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. */ arrival_date: number; /** - * Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). + * Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ automatic: boolean; /** @@ -15952,21 +16626,21 @@ export type Payout = { */ description?: string | null; /** - * ID of the bank account or card the payout was sent to. + * ID of the bank account or card the payout is sent to. */ destination?: | (string | BankAccount | Card | DeletedBankAccount | DeletedCard) | null; /** - * If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. + * If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */ failure_balance_transaction?: (string | BalanceTransaction) | null; /** - * Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. + * Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */ failure_code?: string | null; /** - * Message to user further explaining reason for payout failure if available. + * Message that provides the reason for a payout failure, if available. */ failure_message?: string | null; /** @@ -15984,7 +16658,7 @@ export type Payout = { [key: string]: string; } | null; /** - * The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) + * The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). */ method: string; /** @@ -15996,23 +16670,23 @@ export type Payout = { */ original_payout?: (string | Payout) | null; /** - * If `completed`, the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) may be used to list all Balance Transactions that were paid out in this payout. + * If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. */ reconciliation_status: 'completed' | 'in_progress' | 'not_applicable'; /** - * If the payout was reversed, this is the ID of the payout that reverses this payout. + * If the payout reverses, this is the ID of the payout that reverses this payout. */ reversed_by?: (string | Payout) | null; /** - * The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. + * The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. */ source_type: string; /** - * Extra information about a payout to be displayed on the user's bank statement. + * Extra information about a payout that displays on the user's bank statement. */ statement_descriptor?: string | null; /** - * Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. + * Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */ status: string; /** @@ -16053,13 +16727,14 @@ export type Period = { * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. * - * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information) + * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) */ export type Person = { /** * The account the person is associated with. */ account: string; + additional_tos_acceptances?: PersonAdditionalTosAcceptances; address?: Address; address_kana?: LegalEntityJapanAddress | null; address_kanji?: LegalEntityJapanAddress | null; @@ -16098,7 +16773,7 @@ export type Person = { */ id: string; /** - * Whether the person's `id_number` was provided. + * Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). */ id_number_provided?: boolean; /** @@ -16152,6 +16827,29 @@ export type Person = { ssn_last_4_provided?: boolean; verification?: LegalEntityPersonVerification; }; +/** + * PersonAdditionalTOSAcceptance + */ +export type PersonAdditionalTosAcceptance = { + /** + * The Unix timestamp marking when the legal guardian accepted the service agreement. + */ + date?: number | null; + /** + * The IP address from which the legal guardian accepted the service agreement. + */ + ip?: string | null; + /** + * The user agent of the browser from which the legal guardian accepted the service agreement. + */ + user_agent?: string | null; +}; +/** + * PersonAdditionalTOSAcceptances + */ +export type PersonAdditionalTosAcceptances = { + account: PersonAdditionalTosAcceptance; +}; /** * PersonFutureRequirements */ @@ -16193,6 +16891,10 @@ export type PersonRelationship = { * Whether the person has significant responsibility to control, manage, or direct the organization. */ executive?: boolean | null; + /** + * Whether the person is the legal guardian of the account's representative. + */ + legal_guardian?: boolean | null; /** * Whether the person is an owner of the account’s legal entity. */ @@ -16450,6 +17152,15 @@ export type PortalFlowsAfterCompletionRedirect = { */ return_url: string; }; +/** + * PortalFlowsCouponOffer + */ +export type PortalFlowsCouponOffer = { + /** + * The ID of the coupon to be offered. + */ + coupon: string; +}; /** * PortalFlowsFlow */ @@ -16497,6 +17208,10 @@ export type PortalFlowsFlowAfterCompletion = { * PortalFlowsFlowSubscriptionCancel */ export type PortalFlowsFlowSubscriptionCancel = { + /** + * Specify a retention strategy to be used in the cancellation flow. + */ + retention?: PortalFlowsRetention | null; /** * The ID of the subscription to be canceled. */ @@ -16528,6 +17243,19 @@ export type PortalFlowsFlowSubscriptionUpdateConfirm = { */ subscription: string; }; +/** + * PortalFlowsRetention + */ +export type PortalFlowsRetention = { + /** + * Configuration when `retention.type=coupon_offer`. + */ + coupon_offer?: PortalFlowsCouponOffer | null; + /** + * Type of retention strategy that will be used. + */ + type: 'coupon_offer'; +}; /** * PortalFlowsSubscriptionUpdateConfirmDiscount */ @@ -16550,7 +17278,7 @@ export type PortalFlowsSubscriptionUpdateConfirmItem = { */ id?: string | null; /** - * The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). + * The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ price?: string | null; /** @@ -16826,6 +17554,10 @@ export type Product = { * The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ description?: string | null; + /** + * A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). + */ + features: ProductFeature[]; /** * Unique identifier for the object. */ @@ -16881,6 +17613,15 @@ export type Product = { */ url?: string | null; }; +/** + * ProductFeature + */ +export type ProductFeature = { + /** + * The feature's name. Up to 80 characters long. + */ + name: string; +}; /** * PromotionCode * A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to @@ -17200,7 +17941,7 @@ export type QuotesResourceStatusTransitions = { */ export type QuotesResourceSubscriptionDataSubscriptionData = { /** - * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. + * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @@ -17543,9 +18284,9 @@ export type Recurring = { }; /** * Refund - * `Refund` objects allow you to refund a charge that has previously been created - * but not yet refunded. Funds will be refunded to the credit or debit card that - * was originally charged. + * Refund objects allow you to refund a previously created charge that isn't + * refunded yet. Funds are refunded to the credit or debit card that's + * initially charged. * * Related guide: [Refunds](https://stripe.com/docs/refunds) */ @@ -17559,7 +18300,7 @@ export type Refund = { */ balance_transaction?: (string | BalanceTransaction) | null; /** - * ID of the charge that was refunded. + * ID of the charge that's refunded. */ charge?: (string | Charge) | null; /** @@ -17571,15 +18312,15 @@ export type Refund = { */ currency: string; /** - * An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) + * An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ description?: string; /** - * If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. + * After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ failure_balance_transaction?: string | BalanceTransaction; /** - * If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request` or `unknown`. + * Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. */ failure_reason?: string; /** @@ -17587,7 +18328,7 @@ export type Refund = { */ id: string; /** - * For payment methods without native refund support (e.g., Konbini, PromptPay), email for the customer to receive refund instructions. + * For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. */ instructions_email?: string; /** @@ -17602,11 +18343,11 @@ export type Refund = { */ object: 'refund'; /** - * ID of the PaymentIntent that was refunded. + * ID of the PaymentIntent that's refunded. */ payment_intent?: (string | PaymentIntent) | null; /** - * Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). + * Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). */ reason?: | ( @@ -17621,15 +18362,15 @@ export type Refund = { */ receipt_number?: string | null; /** - * The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. + * The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ source_transfer_reversal?: (string | TransferReversal) | null; /** - * Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. + * Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ status?: string | null; /** - * If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. + * This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ transfer_reversal?: (string | TransferReversal) | null; }; @@ -17954,7 +18695,7 @@ export type SepaDebitGeneratedFrom = { /** * PaymentFlowsSetupIntentSetupAttempt * A SetupAttempt describes one attempted confirmation of a SetupIntent, - * whether that confirmation was successful or unsuccessful. You can use + * whether that confirmation is successful or unsuccessful. You can use * SetupAttempts to inspect details of a specific attempt at setting up a * payment method using a SetupIntent. */ @@ -18111,7 +18852,7 @@ export type SetupAttemptPaymentMethodDetailsCard = { /** * Check results by Card networks on Card address and CVC at the time of authorization */ - checks?: PaymentMethodDetailsCardChecks | null; + checks?: SetupAttemptPaymentMethodDetailsCardChecks | null; /** * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ @@ -18127,7 +18868,7 @@ export type SetupAttemptPaymentMethodDetailsCard = { /** * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * - * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; /** @@ -18151,6 +18892,23 @@ export type SetupAttemptPaymentMethodDetailsCard = { */ wallet?: SetupAttemptPaymentMethodDetailsCardWallet | null; }; +/** + * setup_attempt_payment_method_details_card_checks + */ +export type SetupAttemptPaymentMethodDetailsCardChecks = { + /** + * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ + address_line1_check?: string | null; + /** + * If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ + address_postal_code_check?: string | null; + /** + * If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ + cvc_check?: string | null; +}; /** * setup_attempt_payment_method_details_card_present */ @@ -18180,7 +18938,7 @@ export type SetupAttemptPaymentMethodDetailsCashapp = any; */ export type SetupAttemptPaymentMethodDetailsIdeal = { /** - * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ bank?: | ( @@ -18191,6 +18949,7 @@ export type SetupAttemptPaymentMethodDetailsIdeal = { | 'ing' | 'knab' | 'moneyou' + | 'n26' | 'rabobank' | 'regiobank' | 'revolut' @@ -18214,6 +18973,7 @@ export type SetupAttemptPaymentMethodDetailsIdeal = { | 'INGBNL2A' | 'KNABNL2H' | 'MOYONL21' + | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' @@ -18302,25 +19062,24 @@ export type SetupAttemptPaymentMethodDetailsUsBankAccount = any; /** * SetupIntent * A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. - * For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. + * For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. * Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. * - * Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. - * Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. - * The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides + * Create a SetupIntent when you're ready to collect your customer's payment credentials. + * Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. + * The SetupIntent transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides * you through the setup process. * * Successful SetupIntents result in payment credentials that are optimized for future payments. - * For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through - * [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection - * in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). - * If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success, - * it will automatically attach the resulting payment method to that Customer. + * For example, cardholders in [certain regions](/guides/strong-customer-authentication) might need to be run through + * [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection + * to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). + * If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + * it automatically attaches the resulting payment method to that Customer after successful setup. * We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on - * PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods. + * PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. * - * By using SetupIntents, you ensure that your customers experience the minimum set of required friction, - * even as regulations change over time. + * By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. * * Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents) */ @@ -18414,7 +19173,11 @@ export type SetupIntent = { */ payment_method?: (string | PaymentMethod) | null; /** - * Payment-method-specific configuration for this SetupIntent. + * Information about the payment method configuration used for this Setup Intent. + */ + payment_method_configuration_details?: PaymentMethodConfigBizPaymentMethodConfigurationDetails | null; + /** + * Payment method-specific configuration for this SetupIntent. */ payment_method_options?: SetupIntentPaymentMethodOptions | null; /** @@ -19602,7 +20365,7 @@ export type Subscription = { */ default_tax_rates?: TaxRate[] | null; /** - * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces. + * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @@ -20040,7 +20803,7 @@ export type SubscriptionSchedulePhaseConfiguration = { */ default_tax_rates?: TaxRate[] | null; /** - * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. + * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @@ -20108,7 +20871,7 @@ export type SubscriptionSchedulesResourceDefaultSettings = { */ default_payment_method?: (string | PaymentMethod) | null; /** - * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. + * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @@ -20620,10 +21383,10 @@ export type TaxDeductedAtSource = { }; /** * tax_id - * You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). - * A customer's tax IDs are displayed on invoices and credit notes issued for the customer. + * You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. + * Customer and account tax IDs get displayed on related invoices and credit notes. * - * Related guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids) + * Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) */ export type TaxId = { /** @@ -21266,6 +22029,7 @@ export type TerminalConfiguration = { * String representing the object's type. Objects of the same type share the same value. */ object: 'terminal.configuration'; + offline?: TerminalConfigurationConfigurationResourceOfflineConfig; tipping?: TerminalConfigurationConfigurationResourceTipping; verifone_p400?: TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig; }; @@ -21415,6 +22179,15 @@ export type TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig = */ splashscreen?: string | File; }; +/** + * TerminalConfigurationConfigurationResourceOfflineConfig + */ +export type TerminalConfigurationConfigurationResourceOfflineConfig = { + /** + * Determines whether to allow transactions to be collected while reader is offline. Defaults to false. + */ + enabled?: boolean | null; +}; /** * TerminalConfigurationConfigurationResourceTipping */ @@ -21748,21 +22521,21 @@ export type ThreeDSecureUsage = { * Tokenization is the process Stripe uses to collect sensitive card or bank * account details, or personally identifiable information (PII), directly from * your customers in a secure manner. A token representing this information is - * returned to your server to use. You should use our + * returned to your server to use. Use our * [recommended payments integrations](https://stripe.com/docs/payments) to perform this process - * client-side. This ensures that no sensitive card data touches your server, + * on the client-side. This guarantees that no sensitive card data touches your server, * and allows your integration to operate in a PCI-compliant way. * - * If you cannot use client-side tokenization, you can also create tokens using - * the API with either your publishable or secret API key. Keep in mind that if - * your integration uses this method, you are responsible for any PCI compliance - * that may be required, and you must keep your secret API key safe. Unlike with - * client-side tokenization, your customer's information is not sent directly to - * Stripe, so we cannot determine how it is handled or stored. + * If you can't use client-side tokenization, you can also create tokens using + * the API with either your publishable or secret API key. If + * your integration uses this method, you're responsible for any PCI compliance + * that it might require, and you must keep your secret API key safe. Unlike with + * client-side tokenization, your customer's information isn't sent directly to + * Stripe, so we can't determine how it's handled or stored. * - * Tokens cannot be stored or used more than once. To store card or bank account - * information for later use, you can create [Customer](https://stripe.com/docs/api#customers) - * objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that + * You can't store or use tokens more than once. To store card or bank account + * information for later use, create [Customer](https://stripe.com/docs/api#customers) + * objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). * [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, * performs best with integrations that use client-side tokenization. */ @@ -21770,7 +22543,7 @@ export type Token = { bank_account?: BankAccount; card?: Card; /** - * IP address of the client that generated the token. + * IP address of the client that generates the token. */ client_ip?: string | null; /** @@ -21794,7 +22567,7 @@ export type Token = { */ type: string; /** - * Whether this token has already been used (tokens can be used only once). + * Determines if you have already used this token (you can only use tokens once). */ used: boolean; }; @@ -21986,8 +22759,8 @@ export type TransferData = { */ amount?: number; /** - * The account (if any) the payment will be attributed to for tax - * reporting, and where funds from the payment will be transferred to upon + * The account (if any) that the payment is attributed to for tax + * reporting, and where funds from the payment are transferred to after * payment success. */ destination: string | Account; @@ -23164,7 +23937,7 @@ export type TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetail */ ip_address?: string | null; /** - * `true`` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. + * `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. */ present: boolean; }; @@ -23721,6 +24494,26 @@ export async function postAccountLinks( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + *

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to + * grant client-side API access.

+ */ +export async function postAccountSessions( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/account_sessions', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** *

Returns a list of accounts connected to your platform via Connect. If you’re not a * platform, the list is empty.

@@ -24050,7 +24843,8 @@ export async function getAccountsAccountCapabilitiesCapability( return ctx.handleResponse(res, {}); } /** - *

Updates an existing Account Capability.

+ *

Updates an existing Account Capability. Request or remove a capability by updating its requested + * parameter.

*/ export async function postAccountsAccountCapabilitiesCapability( ctx: r.Context, @@ -24081,6 +24875,7 @@ export async function getAccountsAccountExternalAccounts( ending_before?: string; expand?: string[]; limit?: number; + object?: 'bank_account' | 'card'; starting_after?: string; }, body: any, @@ -24108,7 +24903,13 @@ export async function getAccountsAccountExternalAccounts( params, method: r.HttpMethod.GET, body, - queryParams: ['ending_before', 'expand', 'limit', 'starting_after'], + queryParams: [ + 'ending_before', + 'expand', + 'limit', + 'object', + 'starting_after', + ], auth: ['basicAuth', 'bearerAuth'], }); const res = await ctx.sendRequest(req, opts); @@ -24247,6 +25048,7 @@ export async function getAccountsAccountPeople( relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; representative?: boolean; }; @@ -24391,6 +25193,7 @@ export async function getAccountsAccountPersons( relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; representative?: boolean; }; @@ -25595,22 +26398,21 @@ export async function postChargesChargeDisputeClose( return ctx.handleResponse(res, {}); } /** - *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create - * it.

+ *

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

* - *

Creating a new refund will refund a charge that has previously been created but not yet refunded. - * Funds will - * be refunded to the credit or debit card that was originally charged.

+ *

This action refunds + * a previously created charge that’s not refunded yet. + * Funds are refunded to the credit or debit card that’s originally + * charged.

* - *

You can optionally refund only part of a - * charge. - * You can do so multiple times, until the entire charge has been refunded.

+ *

You can optionally refund only part of a charge. + * You can repeat this until the entire charge is + * refunded.

* - *

Once entirely refunded, a - * charge can’t be refunded again. - * This method will raise an error when called on an already-refunded charge, - * or when - * trying to refund more money than is left on a charge.

+ *

After you entirely refund a charge, you can’t refund it again. + * This method raises an error when it’s + * called on an already-refunded charge, + * or when you attempt to refund more money than is left on a charge.

*/ export async function postChargesChargeRefund( ctx: r.Context, @@ -25676,7 +26478,22 @@ export async function getChargesChargeRefunds( return ctx.handleResponse(res, {}); } /** - *

Create a refund.

+ *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create + * it.

+ * + *

Creating a new refund will refund a charge that has previously been created but not yet refunded. + * Funds will + * be refunded to the credit or debit card that was originally charged.

+ * + *

You can optionally refund only part of a + * charge. + * You can do so multiple times, until the entire charge has been refunded.

+ * + *

Once entirely refunded, a + * charge can’t be refunded again. + * This method will raise an error when called on an already-refunded charge, + * or when + * trying to refund more money than is left on a charge.

*/ export async function postChargesChargeRefunds( ctx: r.Context, @@ -27790,7 +28607,7 @@ export async function getCustomersCustomerTaxIds( return ctx.handleResponse(res, {}); } /** - *

Creates a new TaxID object for a customer.

+ *

Creates a new tax_id object for a customer.

*/ export async function postCustomersCustomerTaxIds( ctx: r.Context, @@ -27811,7 +28628,7 @@ export async function postCustomersCustomerTaxIds( return ctx.handleResponse(res, {}); } /** - *

Deletes an existing TaxID object.

+ *

Deletes an existing tax_id object.

*/ export async function deleteCustomersCustomerTaxIdsId( ctx: r.Context, @@ -27833,7 +28650,7 @@ export async function deleteCustomersCustomerTaxIdsId( return ctx.handleResponse(res, {}); } /** - *

Retrieves the TaxID object with the given identifier.

+ *

Retrieves the tax_id object with the given identifier.

*/ export async function getCustomersCustomerTaxIdsId( ctx: r.Context, @@ -28301,8 +29118,8 @@ export async function postFileLinksLink( return ctx.handleResponse(res, {}); } /** - *

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the - * most recently created files appearing first.

+ *

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation + * dates, placing the most recently created files at the top.

*/ export async function getFiles( ctx: r.Context, @@ -28372,11 +29189,11 @@ export async function getFiles( return ctx.handleResponse(res, {}); } /** - *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request - * should contain the file you would like to upload, as well as the parameters for creating a file.

+ *

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you + * want to upload in the request, and the parameters for creating a file.

* - *

All of Stripe’s - * officially supported Client libraries should have support for sending multipart/form-data.

+ *

All of Stripe’s officially supported + * Client libraries support sending multipart/form-data.

*/ export async function postFiles( ctx: r.Context, @@ -28395,9 +29212,8 @@ export async function postFiles( return ctx.handleResponse(res, {}); } /** - *

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the - * corresponding file object. To access file contents, see the File - * Upload Guide.

+ *

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding + * file object. Learn how to access file contents.

*/ export async function getFilesFile( ctx: r.Context, @@ -30113,11 +30929,11 @@ export async function postIssuingAuthorizationsAuthorization( return ctx.handleResponse(res, {}); } /** - *

Approves a pending Issuing Authorization object. This request should be made within the timeout window - * of the real-time authorization flow. - * You can also respond - * directly to the webhook request to approve an authorization (preferred). More details can be found here.

+ *

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the + * timeout window of the real-time authorization flow. + * This + * method is deprecated. Instead, respond + * directly to the webhook request to approve an authorization.

*/ export async function postIssuingAuthorizationsAuthorizationApprove< FetcherData, @@ -30140,11 +30956,11 @@ export async function postIssuingAuthorizationsAuthorizationApprove< return ctx.handleResponse(res, {}); } /** - *

Declines a pending Issuing Authorization object. This request should be made within the timeout window - * of the real time authorization flow. - * You can also respond - * directly to the webhook request to decline an authorization (preferred). More details can be found here.

+ *

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the + * timeout window of the real time authorization flow. + * This + * method is deprecated. Instead, respond + * directly to the webhook request to decline an authorization.

*/ export async function postIssuingAuthorizationsAuthorizationDecline< FetcherData, @@ -30670,6 +31486,107 @@ export async function postIssuingSettlementsSettlement( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + *

Lists all Issuing Token objects for a given card.

+ */ +export async function getIssuingTokens( + ctx: r.Context, + params: { + card: string; + created?: + | { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } + | number; + ending_before?: string; + expand?: string[]; + limit?: number; + starting_after?: string; + status?: 'active' | 'deleted' | 'requested' | 'suspended'; + }, + body: any, + opts?: FetcherData, +): Promise<{ + data: IssuingToken[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: 'list'; + /** + * The URL where this list can be accessed. + */ + url: string; +}> { + const req = await ctx.createRequest({ + path: '/v1/issuing/tokens', + params, + method: r.HttpMethod.GET, + body, + queryParams: [ + 'card', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status', + ], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Retrieves an Issuing Token object.

+ */ +export async function getIssuingTokensToken( + ctx: r.Context, + params: { + expand?: string[]; + token: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/issuing/tokens/{token}', + params, + method: r.HttpMethod.GET, + body, + queryParams: ['expand'], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Attempts to update the specified Issuing Token object to the status specified.

+ */ +export async function postIssuingTokensToken( + ctx: r.Context, + params: { + token: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/issuing/tokens/{token}', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** *

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation * date, with the most recently created object appearing first.

@@ -31071,17 +31988,17 @@ export async function getPaymentIntents( * *

After the PaymentIntent is created, attach a payment method and confirm - * to continue the payment. You can read more about the different - * payment flows - * available via the Payment Intents API here.

+ * to continue the payment. Learn more about the available payment flows + * with the Payment Intents API.

* - *

When - * confirm=true is used during creation, it is equivalent to creating - * and confirming the PaymentIntent in the - * same call. You may use any parameters - * available in the confirm API when - * confirm=true - * is supplied.

+ *

When you use + * confirm=true during creation, it’s equivalent to creating + * and confirming the PaymentIntent in the same + * call. You can use any parameters + * available in the confirm API when you + * supply + * confirm=true.

*/ export async function postPaymentIntents( ctx: r.Context, @@ -31147,11 +32064,11 @@ export async function getPaymentIntentsSearch( /** *

Retrieves the details of a PaymentIntent that has previously been created.

* - *

Client-side retrieval using a - * publishable key is allowed when the client_secret is provided in the query string.

+ *

You can retrieve a PaymentIntent + * client-side using a publishable key when the client_secret is in the query string.

* - *

When retrieved - * with a publishable key, only a subset of properties will be returned. Please refer to the If you retrieve + * a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

*/ export async function getPaymentIntentsIntent( @@ -31179,12 +32096,12 @@ export async function getPaymentIntentsIntent( *

Updates properties on a PaymentIntent object without confirming.

* *

Depending on which properties you update, - * you may need to confirm the - * PaymentIntent again. For example, updating the payment_method will - * always - * require you to confirm the PaymentIntent again. If you prefer to - * update and confirm at the same time, we recommend - * updating properties via + * you might need to confirm the + * PaymentIntent again. For example, updating the payment_method + * always requires + * you to confirm the PaymentIntent again. If you prefer to + * update and confirm at the same time, we recommend updating + * properties through * the confirm API instead.

*/ export async function postPaymentIntentsIntent( @@ -31206,7 +32123,7 @@ export async function postPaymentIntentsIntent( return ctx.handleResponse(res, {}); } /** - *

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

+ *

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

*/ export async function postPaymentIntentsIntentApplyCustomerBalance( ctx: r.Context, @@ -31227,16 +32144,16 @@ export async function postPaymentIntentsIntentApplyCustomerBalance( return ctx.handleResponse(res, {}); } /** - *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, + *

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, * requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

* - *

Once canceled, no additional charges - * will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents - * with a status of requires_capture, the remaining amount_capturable will - * automatically be refunded.

+ *

After it’s canceled, no additional + * charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents + * with a status of requires_capture, the remaining amount_capturable is + * automatically refunded.

* - *

You cannot cancel the PaymentIntent for a Checkout Session. You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

*/ export async function postPaymentIntentsIntentCancel( @@ -31261,8 +32178,8 @@ export async function postPaymentIntentsIntentCancel( *

Capture the funds of an existing uncaptured PaymentIntent when its status is * requires_capture.

* - *

Uncaptured PaymentIntents will be canceled a set number of days after they are - * created (7 by default).

+ *

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after + * their creation.

* *

Learn more about separate authorization and * capture.

@@ -31354,27 +32271,27 @@ export async function postPaymentIntentsIntentConfirm( * *

Incremental authorizations attempt to increase the authorized amount on * your customer’s - * card to the new, higher amount provided. As with the - * initial authorization, incremental authorizations may - * be declined. A + * card to the new, higher amount provided. Similar to the + * initial authorization, incremental authorizations + * can be declined. A * single PaymentIntent can call this endpoint multiple times to further * increase the authorized * amount.

* - *

If the incremental authorization succeeds, the PaymentIntent object is - * returned with the updated + *

If the incremental authorization succeeds, the PaymentIntent object + * returns with the updated * amount. * If the incremental authorization fails, * a - * card_declined error is returned, and no + * card_declined error returns, and no other * fields on the PaymentIntent or - * Charge are updated. The PaymentIntent + * Charge update. The PaymentIntent * object remains capturable for the previously authorized amount.

* *

Each * PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. - * Once captured, a + * After it’s captured, a * PaymentIntent can no longer be incremented.

* *

Learn more about ( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + *

List payment method configurations

+ */ +export async function getPaymentMethodConfigurations( + ctx: r.Context, + params: { + application?: string | ''; + expand?: string[]; + }, + body: any, + opts?: FetcherData, +): Promise<{ + data: PaymentMethodConfiguration[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: 'list'; + /** + * The URL where this list can be accessed. + */ + url: string; +}> { + const req = await ctx.createRequest({ + path: '/v1/payment_method_configurations', + params, + method: r.HttpMethod.GET, + body, + queryParams: ['application', 'expand'], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Creates a payment method configuration

+ */ +export async function postPaymentMethodConfigurations( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_configurations', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Retrieve payment method configuration

+ */ +export async function getPaymentMethodConfigurationsConfiguration( + ctx: r.Context, + params: { + configuration: string; + expand?: string[]; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_configurations/{configuration}', + params, + method: r.HttpMethod.GET, + body, + queryParams: ['expand'], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Update payment method configuration

+ */ +export async function postPaymentMethodConfigurationsConfiguration( + ctx: r.Context, + params: { + configuration: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_configurations/{configuration}', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Lists the details of existing payment method domains.

+ */ +export async function getPaymentMethodDomains( + ctx: r.Context, + params: { + domain_name?: string; + enabled?: boolean; + ending_before?: string; + expand?: string[]; + limit?: number; + starting_after?: string; + }, + body: any, + opts?: FetcherData, +): Promise<{ + data: PaymentMethodDomain[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: 'list'; + /** + * The URL where this list can be accessed. + */ + url: string; +}> { + const req = await ctx.createRequest({ + path: '/v1/payment_method_domains', + params, + method: r.HttpMethod.GET, + body, + queryParams: [ + 'domain_name', + 'enabled', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + ], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Creates a payment method domain.

+ */ +export async function postPaymentMethodDomains( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_domains', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Retrieves the details of an existing payment method domain.

+ */ +export async function getPaymentMethodDomainsPaymentMethodDomain( + ctx: r.Context, + params: { + expand?: string[]; + payment_method_domain: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_domains/{payment_method_domain}', + params, + method: r.HttpMethod.GET, + body, + queryParams: ['expand'], + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Updates an existing payment method domain.

+ */ +export async function postPaymentMethodDomainsPaymentMethodDomain( + ctx: r.Context, + params: { + payment_method_domain: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_domains/{payment_method_domain}', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t + * satisfied when the domain was created, the payment method will be inactive on the domain. + * The payment method doesn’t + * appear in Elements for this domain until it is active.

+ * + *

To activate a payment method on an existing payment + * method domain, complete the required validation steps specific to the payment method, and then validate the payment + * method domain with this endpoint.

+ * + *

Related guides: Payment method domains.

+ */ +export async function postPaymentMethodDomainsPaymentMethodDomainValidate< + FetcherData, +>( + ctx: r.Context, + params: { + payment_method_domain: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/payment_method_domains/{payment_method_domain}/validate', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** *

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer * for payments, you should use the List a Customer’s PaymentMethods @@ -31791,8 +32952,8 @@ export async function postPaymentMethodsPaymentMethodDetach( return ctx.handleResponse(res, {}); } /** - *

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are - * returned in sorted order, with the most recently created payouts appearing first.

+ *

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts + * return in sorted order, with the most recently created payouts appearing first.

*/ export async function getPayouts( ctx: r.Context, @@ -31858,16 +33019,16 @@ export async function getPayouts( return ctx.handleResponse(res, {}); } /** - *

To send funds to your own bank account, you create a new payout object. Your Stripe balance - * must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

+ *

To send funds to your own bank account, create a new payout object. Your Stripe balance must + * cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

* - *

If your API key is in - * test mode, money won’t actually be sent, though everything else will occur as if in live mode.

+ *

If your API key is in test + * mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

* - *

If you are - * creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source - * type balance that the payout should draw from. The balance object details available and - * pending amounts by source type.

+ *

If you create a + * manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance + * that the payout draws from. The balance object details available and pending amounts by + * source type.

*/ export async function postPayouts( ctx: r.Context, @@ -31887,7 +33048,7 @@ export async function postPayouts( } /** *

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the - * payout list, and Stripe will return the corresponding payout information.

+ * payout list. Stripe returns the corresponding payout information.

*/ export async function getPayoutsPayout( ctx: r.Context, @@ -31910,8 +33071,8 @@ export async function getPayoutsPayout( return ctx.handleResponse(res, {}); } /** - *

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left - * unchanged. This request accepts only the metadata as arguments.

+ *

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you + * don’t provide. This request only accepts the metadata as arguments.

*/ export async function postPayoutsPayout( ctx: r.Context, @@ -31932,8 +33093,8 @@ export async function postPayoutsPayout( return ctx.handleResponse(res, {}); } /** - *

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available - * balance. You may not cancel automatic Stripe payouts.

+ *

You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available + * balance. You can’t cancel automatic Stripe payouts.

*/ export async function postPayoutsPayoutCancel( ctx: r.Context, @@ -31954,13 +33115,13 @@ export async function postPayoutsPayoutCancel( return ctx.handleResponse(res, {}); } /** - *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts - * may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel - * should be used instead.

+ *

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected + * accounts to US bank accounts. If the payout is in the pending status, use + * /v1/payouts/:id/cancel instead.

* - *

By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the - * authorized signatory of the selected bank account has authorized the debit on the bank account and that no other - * authorization is required.

+ *

By requesting a reversal through + * /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes + * the debit on the bank account and that no other authorization is required.

*/ export async function postPayoutsPayoutReverse( ctx: r.Context, @@ -33259,9 +34420,8 @@ export async function postRadarValueListsValueList( return ctx.handleResponse(res, {}); } /** - *

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most - * recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the - * charge object.

+ *

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds + * appearing first The 10 most recent refunds are always available by default on the Charge object.

*/ export async function getRefunds( ctx: r.Context, @@ -33318,7 +34478,22 @@ export async function getRefunds( return ctx.handleResponse(res, {}); } /** - *

Create a refund.

+ *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create + * it.

+ * + *

Creating a new refund will refund a charge that has previously been created but not yet refunded. + * Funds will + * be refunded to the credit or debit card that was originally charged.

+ * + *

You can optionally refund only part of a + * charge. + * You can do so multiple times, until the entire charge has been refunded.

+ * + *

Once entirely refunded, a + * charge can’t be refunded again. + * This method will raise an error when called on an already-refunded charge, + * or when + * trying to refund more money than is left on a charge.

*/ export async function postRefunds( ctx: r.Context, @@ -33360,8 +34535,8 @@ export async function getRefundsRefund( return ctx.handleResponse(res, {}); } /** - *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left - * unchanged.

+ *

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t + * provide remain unchanged.

* *

This request only accepts metadata as an argument.

*/ @@ -33386,8 +34561,8 @@ export async function postRefundsRefund( /** *

Cancels a refund with a status of requires_action.

* - *

Refunds in other states cannot be canceled, - * and only refunds for payment methods that require customer action will enter the requires_action state.

+ *

You can’t cancel refunds in other states. + * Only refunds for payment methods that require customer action can enter the requires_action state.

*/ export async function postRefundsRefundCancel( ctx: r.Context, @@ -33662,7 +34837,7 @@ export async function postReviewsReviewApprove( return ctx.handleResponse(res, {}); } /** - *

Returns a list of SetupAttempts associated with a provided SetupIntent.

+ *

Returns a list of SetupAttempts that associate with a provided SetupIntent.

*/ export async function getSetupAttempts( ctx: r.Context, @@ -33778,9 +34953,9 @@ export async function getSetupIntents( /** *

Creates a SetupIntent object.

* - *

After the SetupIntent is created, attach a payment method and After you create the SetupIntent, attach a payment method and confirm - * to collect any required permissions to charge the payment method + * it to collect any required permissions to charge the payment method * later.

*/ export async function postSetupIntents( @@ -33852,11 +35027,11 @@ export async function postSetupIntentsIntent( return ctx.handleResponse(res, {}); } /** - *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, + *

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, * requires_confirmation, or requires_action.

* - *

Once canceled, setup is abandoned and any - * operations on the SetupIntent will fail with an error.

+ *

After you cancel it, setup is abandoned + * and any operations on the SetupIntent fail with an error.

*/ export async function postSetupIntentsIntentCancel( ctx: r.Context, @@ -34946,9 +36121,50 @@ export async function getSubscriptionsSubscriptionExposedId( return ctx.handleResponse(res, {}); } /** - *

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, - * we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration - * will be calculated, use the upcoming invoice endpoint.

+ *

Updates an existing subscription to match the specified parameters. + * When changing prices or quantities, we optionally + * prorate the price we charge next month to make up for any price changes. + * To preview how the proration is calculated, use + * the upcoming invoice endpoint.

+ * + *

By default, we prorate subscription + * changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed + * 100 immediately. If on May 15 they switch to a 200 price, then on June 1 + * they’ll be billed 250 (200 for a renewal of her subscription, plus a + * 50 prorating adjustment for half of the previous month’s 100 difference). + * Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity + * changes.

+ * + *

Switching prices does not normally change the billing date or generate an immediate charge + * unless:

+ * + *
    + *
  • The billing interval is changed (for example, from monthly to yearly).
    • + *
  • The subscription + * moves from free to paid, or paid to free.
    • + *
  • A trial starts or ends.
    • + *
+ * + *

In these cases, we apply a + * credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the + * billing date.

+ * + *

If you want to charge for an upgrade immediately, pass proration_behavior as + * always_invoice to create prorations, automatically invoice the customer for those proration adjustments, + * and attempt to collect payment. If you pass create_prorations, the prorations are created but not + * automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you + * need to manually invoice the customer.

+ * + *

If you don’t want to prorate, set + * the proration_behavior option to none. With this option, the customer is billed + * 100 on May 1 and 200 on June 1. Similarly, if you set + * proration_behavior to none when switching between different billing intervals (for example, + * from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the + * billing date and bill immediately for the new subscription.

+ * + *

Updating the quantity on a subscription many times + * in an hour may result in rate limiting. If you need to bill for a frequently changing + * quantity, consider integrating usage-based billing instead.

*/ export async function postSubscriptionsSubscriptionExposedId( ctx: r.Context, @@ -35701,6 +36917,7 @@ export async function getTerminalReaders( expand?: string[]; limit?: number; location?: string; + serial_number?: string; starting_after?: string; status?: 'offline' | 'online'; }, @@ -35735,6 +36952,7 @@ export async function getTerminalReaders( 'expand', 'limit', 'location', + 'serial_number', 'starting_after', 'status', ], @@ -35958,6 +37176,117 @@ export async function postTestHelpersCustomersCustomerFundCashBalance< const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + *

Create a test-mode authorization.

+ */ +export async function postTestHelpersIssuingAuthorizations( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/authorizations', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Capture a test-mode authorization.

+ */ +export async function postTestHelpersIssuingAuthorizationsAuthorizationCapture< + FetcherData, +>( + ctx: r.Context, + params: { + authorization: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/authorizations/{authorization}/capture', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Expire a test-mode Authorization.

+ */ +export async function postTestHelpersIssuingAuthorizationsAuthorizationExpire< + FetcherData, +>( + ctx: r.Context, + params: { + authorization: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/authorizations/{authorization}/expire', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Increment a test-mode Authorization.

+ */ +export async function postTestHelpersIssuingAuthorizationsAuthorizationIncrement< + FetcherData, +>( + ctx: r.Context, + params: { + authorization: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/authorizations/{authorization}/increment', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Reverse a test-mode Authorization.

+ */ +export async function postTestHelpersIssuingAuthorizationsAuthorizationReverse< + FetcherData, +>( + ctx: r.Context, + params: { + authorization: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/authorizations/{authorization}/reverse', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** *

Updates the shipping status of the specified Issuing Card object to delivered.

*/ @@ -36046,6 +37375,71 @@ export async function postTestHelpersIssuingCardsCardShippingShip( const res = await ctx.sendRequest(req, opts); return ctx.handleResponse(res, {}); } +/** + *

Allows the user to capture an arbitrary amount, also known as a forced capture.

+ */ +export async function postTestHelpersIssuingTransactionsCreateForceCapture< + FetcherData, +>( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/transactions/create_force_capture', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

+ */ +export async function postTestHelpersIssuingTransactionsCreateUnlinkedRefund< + FetcherData, +>( + ctx: r.Context, + params: {}, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/transactions/create_unlinked_refund', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} +/** + *

Refund a test-mode Transaction.

+ */ +export async function postTestHelpersIssuingTransactionsTransactionRefund< + FetcherData, +>( + ctx: r.Context, + params: { + transaction: string; + }, + body: any, + opts?: FetcherData, +): Promise { + const req = await ctx.createRequest({ + path: '/v1/test_helpers/issuing/transactions/{transaction}/refund', + params, + method: r.HttpMethod.POST, + body, + auth: ['basicAuth', 'bearerAuth'], + }); + const res = await ctx.sendRequest(req, opts); + return ctx.handleResponse(res, {}); +} /** *

Expire a refund with a status of requires_action.

*/ @@ -36473,9 +37867,9 @@ export async function postTestHelpersTreasuryReceivedDebits( } /** *

Creates a single-use token that represents a bank account’s details. - * This token can be used with any API method in - * place of a bank account dictionary. This token can be used only once, by attaching it to a Custom - * account.

+ * You can use this token with any API method in + * place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

*/ export async function postTokens( ctx: r.Context, diff --git a/packages/typoas-cli/package.json b/packages/typoas-cli/package.json index b41a946..5c901df 100644 --- a/packages/typoas-cli/package.json +++ b/packages/typoas-cli/package.json @@ -1,6 +1,6 @@ { "name": "@typoas/cli", - "version": "3.1.4", + "version": "3.1.5", "license": "MIT", "repository": { "type": "git", diff --git a/packages/typoas-generator/package.json b/packages/typoas-generator/package.json index 93d797e..f8a686c 100644 --- a/packages/typoas-generator/package.json +++ b/packages/typoas-generator/package.json @@ -1,6 +1,6 @@ { "name": "@typoas/generator", - "version": "3.1.4", + "version": "3.1.5", "license": "MIT", "repository": { "type": "git",